notio
Class Designator

java.lang.Object
  |
  +--notio.Designator
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
DefinedDesignator, LiteralDesignator, MarkerDesignator, NameDesignator

public abstract class Designator
extends java.lang.Object
implements java.io.Serializable

Base class for designators.

See Also:
Serialized Form

Field Summary
static int DESIGNATOR_DEFINED
          Indicates that a designator is a DefinedDesignator.
static int DESIGNATOR_LITERAL
          Indicates that a designator is a LiteralDesignator.
static int DESIGNATOR_MARKER
          Indicates that a designator is a LocatorDesignator.
static int DESIGNATOR_NAME
          Indicates that a designator is a NameDesignator.
 
Constructor Summary
Designator()
           
 
Method Summary
abstract  Designator copy(CopyingScheme copyScheme, java.util.Hashtable substitutionTable)
          Performs a copy operation on this designator according to the the specified CopyingScheme.
 boolean getCaseSensitiveLabels()
          Returns true if the processing of labels in this designator is case-sensitive.
abstract  int getDesignatorKind()
          Returns a constant indicating which kind of designator this is.
 Referent getEnclosingReferent()
          Returns the enclosing referent for this designator or null if there isn't one.
static MatchResult matchDesignators(Designator first, Designator second, MatchingScheme matchingScheme)
          Compares two designators to decide if they match.
 void setCaseSensitiveLabels(boolean flag)
          Sets a flag indicating whether or not the processing of labels within this designator is case-sensitive.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DESIGNATOR_LITERAL

public static final int DESIGNATOR_LITERAL
Indicates that a designator is a LiteralDesignator.

DESIGNATOR_MARKER

public static final int DESIGNATOR_MARKER
Indicates that a designator is a LocatorDesignator.

DESIGNATOR_DEFINED

public static final int DESIGNATOR_DEFINED
Indicates that a designator is a DefinedDesignator.

DESIGNATOR_NAME

public static final int DESIGNATOR_NAME
Indicates that a designator is a NameDesignator.
Constructor Detail

Designator

public Designator()
Method Detail

getDesignatorKind

public abstract int getDesignatorKind()
Returns a constant indicating which kind of designator this is. The constant is one of: Designator.DESIGNATOR_LITERAL Designator.DESIGNATOR_MARKER Designator.DESIGNATOR_DEFINED Designator.DESIGNATOR_NAME
Returns:
a constant indicating the kind of the designator.

copy

public abstract 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.

setCaseSensitiveLabels

public void setCaseSensitiveLabels(boolean flag)
Sets a flag indicating whether or not the processing of labels within this designator is case-sensitive.
Parameters:
flag - the flag setting for case-sensitivity.

getCaseSensitiveLabels

public boolean getCaseSensitiveLabels()
Returns true if the processing of labels in this designator is case-sensitive.
Returns:
true if the processing of labels in this designator is case-sensitive.

getEnclosingReferent

public Referent getEnclosingReferent()
Returns the enclosing referent for this designator or null if there isn't one.
Returns:
the enclosing referent for this designator or null.

matchDesignators

public static MatchResult matchDesignators(Designator first,
                                           Designator second,
                                           MatchingScheme matchingScheme)
Compares two designators to decide if they match. The exact semantics of matching are determined by the match control flag.
Parameters:
first - the first designators being matched.
second - the second designators being matched.
matchingScheme - the matching scheme that determines how the match is performed.
Returns:
true if the two designators match according to the scheme's criteria.


Copyright 1998-2001 Finnegan Southey