notio
Class SetDesignator
java.lang.Object
|
+--notio.Designator
|
+--notio.SetDesignator
- public class SetDesignator
- extends Designator
- implements java.io.Serializable
Class for set designators. A designator of this kind specifies a
collective set of other designators.
- See Also:
- Serialized Form
Method Summary |
Designator |
copy(CopyingScheme copyScheme,
java.util.Hashtable substitutionTable)
Performs a copy operation on this designator according to the
the specified CopyingScheme. |
int |
getDesignatorKind()
Returns a constant indicating which kind of designator is. |
Designator[] |
getDesignatorSet()
Returns an array of the designators in this set or null, indicating a
generic set. |
Marker |
getMarker()
Returns the marker associated with the designator set. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
SetDesignator
public SetDesignator(Designator[] newDesignatorSet,
MarkerSet markerSet)
- Constructs a new SetDesignator with the specified designators. If null
is passed in place of an array, the designator set is assumed to be
generic.
// BUG: Currently SetDesignators may contain other SetDesignators. Is
// this a problem or a feature?
- Parameters:
newDesignatorSet
- an array of designators that will form the
set or null to indicate generic set.markerSet
- the markerSet associated with this designator.
getDesignatorKind
public int getDesignatorKind()
- Returns a constant indicating which kind of designator is.
In this case the constant will be: Designator.DESIGNATOR_SET
- Returns:
- a constant indicating the kind of the designator.
- Overrides:
- getDesignatorKind in class Designator
getDesignatorSet
public Designator[] getDesignatorSet()
- Returns an array of the designators in this set or null, indicating a
generic set.
- Returns:
- an array of the designators in this set or null, indicating a
generic set.
getMarker
public Marker getMarker()
- Returns the marker associated with the designator set. This is
equivalent to a lookup using MarkerSet.getMarkerByIndividual() with the
internal representation of the designator set as an argument. As such,
it is probably not useful for comparing designators. Instead, the
set should be compared element by element.
- Returns:
- the marker associated with the designator set.
copy
public Designator copy(CopyingScheme copyScheme,
java.util.Hashtable substitutionTable)
- Performs a copy operation on this designator according to the
the specified CopyingScheme.
The result may be a new designator or simply a reference to this designator
depending on the scheme.
- Parameters:
copyScheme
- the copying scheme used to control the copy operation.substitutionTable
- a hashtable containing copied objects available due to
earlier copy operations.- Returns:
- the result of the copy operation.
- Overrides:
- copy in class Designator
Copyright 1998-1999 Finnegan Southey