notio
Class MarkerDesignator

java.lang.Object
  |
  +--notio.Designator
        |
        +--notio.MarkerDesignator

public class MarkerDesignator
extends Designator
implements java.io.Serializable

Class for locator designators. Used for references by individual marker.

See Also:
Serialized Form

Fields inherited from class notio.Designator
DESIGNATOR_DEFINED, DESIGNATOR_DESCRIPTOR, DESIGNATOR_LITERAL, DESIGNATOR_MARKER, DESIGNATOR_NAME, DESIGNATOR_SET
 
Constructor Summary
MarkerDesignator(Marker newMarker)
          Constructs a new MarkerDesignator with the specified marker.
MarkerDesignator(MarkerSet markerSet)
          Constructs a new MarkerDesignator with the specified marker set.
 
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.
 Marker getMarker()
          Returns the marker associated with this designator.
 
Methods inherited from class notio.Designator
getCaseSensitiveLabels, getEnclosingReferent, matchDesignators, setCaseSensitiveLabels
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MarkerDesignator

public MarkerDesignator(MarkerSet markerSet)
Constructs a new MarkerDesignator with the specified marker set. A marker will be constructed and added to the set automatically.
Parameters:
markerSet - the marker set associated with this designator.

MarkerDesignator

public MarkerDesignator(Marker newMarker)
Constructs a new MarkerDesignator with the specified marker. The marker is assumed to be valid and already a member of some marker set.
Parameters:
newMarker - the marker associated with this designator.
Method Detail

getDesignatorKind

public int getDesignatorKind()
Returns a constant indicating which kind of designator is. In this case the constant will be: Designator.DESIGNATOR_MARKER
Returns:
a constant indicating the kind of the designator.
Overrides:
getDesignatorKind in class Designator

getMarker

public Marker getMarker()
Returns the marker associated with this designator.
Returns:
the marker associated with this designator.

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