ConForM.CoopnTools.CoKer.CoopnMgr
Class CoopnName

java.lang.Object
  |
  +--ConForM.CoopnTools.CoKer.CoopnMgr.CoopnElement
        |
        +--ConForM.CoopnTools.CoKer.CoopnMgr.CoopnName
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable, CoopnSyntacticElement, java.io.Serializable
Direct Known Subclasses:
CoopnAnonymousName

public class CoopnName
extends CoopnElement
implements java.lang.Comparable

Coopn name. This class is critical and should not be extended, except by CoopnAnonymousName.

See Also:
CoopnElement, Serialized Form

Constructor Summary
CoopnName(ConForM.CoopnTools.CoKer.CoopnMgr.CoopnTextMgr.CoopnTextName name)
          Simple constructor.
CoopnName(java.lang.String baseName)
          Simple constructor.
 
Method Summary
 java.lang.String baseName()
          Return the base name.
 java.lang.Object clone()
          Cloning method.
 int compareTo(java.lang.Object o)
           
 boolean equals(java.lang.Object obj)
          Equality method.
static CoopnName fromString(java.lang.String s, CoopnEnv env)
           
static CoopnName fromTextName(ConForM.CoopnTools.CoKer.CoopnMgr.CoopnTextMgr.CoopnTextName name)
           
 int hashCode()
          Hashcode method.
 CoopnName intern()
          Return a unique instance of an element.
 CoopnElement interpret(CoopnSubstitution sigma)
          Interpretation of this element according to a substitution.
 ConForM.CoopnTools.CoKer.CoopnMgr.CoopnCocoMgr.CoopnCocoElement toCoco(CoopnSymbolTable table)
          CoCo conversion method.
 ConForM.CoopnTools.CoKer.CoopnMgr.CoopnTextMgr.CoopnTextElement toCompleteText(CoopnSymbolTable table)
          Complete textual elements conversion method.
static java.lang.String toString(CoopnName name)
           
 ConForM.CoopnTools.CoKer.CoopnMgr.CoopnTextMgr.CoopnTextElement toText()
          Textual elements conversion method.
static ConForM.CoopnTools.CoKer.CoopnMgr.CoopnTextMgr.CoopnTextName toTextName(CoopnName name)
           
 java.lang.Object unmodifiableCopy()
          Copy the element into an unmodifiable structure.
 
Methods inherited from class ConForM.CoopnTools.CoKer.CoopnMgr.CoopnElement
cloneCoopnElement, pureCOIL, pureCOOPN, toCompleteString, toCompleteString, toCompleteString, toCompleteString, toCompleteString, toCompleteString, toCompleteText, toCompleteTokens, toCompleteTokens, toCompleteTokens, toCompleteTokens, toCompleteTokens, toCompleteTokens, toString, toString, toString, toTokens, toTokens, toTokens
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CoopnName

public CoopnName(ConForM.CoopnTools.CoKer.CoopnMgr.CoopnTextMgr.CoopnTextName name)
          throws java.lang.IllegalArgumentException
Simple constructor.

CoopnName

public CoopnName(java.lang.String baseName)
          throws java.lang.IllegalArgumentException
Simple constructor.
Parameters:
baseName - the name
Method Detail

compareTo

public int compareTo(java.lang.Object o)
Specified by:
compareTo in interface java.lang.Comparable

fromTextName

public static CoopnName fromTextName(ConForM.CoopnTools.CoKer.CoopnMgr.CoopnTextMgr.CoopnTextName name)

fromString

public static CoopnName fromString(java.lang.String s,
                                   CoopnEnv env)

baseName

public java.lang.String baseName()
Return the base name.
Returns:
the base name

interpret

public CoopnElement interpret(CoopnSubstitution sigma)
Description copied from class: CoopnElement
Interpretation of this element according to a substitution.
Overrides:
interpret in class CoopnElement
Following copied from class: ConForM.CoopnTools.CoKer.CoopnMgr.CoopnElement
Parameters:
sigma - the substitution; cannot be null
Returns:
a new CoopnElement object, coreesponding to the interpretation.

equals

public boolean equals(java.lang.Object obj)
Description copied from class: CoopnElement
Equality method. Must be defined in the inherited classes.
Overrides:
equals in class CoopnElement
Following copied from class: ConForM.CoopnTools.CoKer.CoopnMgr.CoopnElement
Parameters:
obj - the object to compare
Returns:
true iff this object and the parameter are equals.

hashCode

public int hashCode()
Description copied from class: CoopnElement
Hashcode method. Must be defined in the inherited classes.
Overrides:
hashCode in class CoopnElement
Following copied from class: ConForM.CoopnTools.CoKer.CoopnMgr.CoopnElement
Returns:
the hash code.

toTextName

public static ConForM.CoopnTools.CoKer.CoopnMgr.CoopnTextMgr.CoopnTextName toTextName(CoopnName name)

toString

public static java.lang.String toString(CoopnName name)

toText

public ConForM.CoopnTools.CoKer.CoopnMgr.CoopnTextMgr.CoopnTextElement toText()
Description copied from class: CoopnElement
Textual elements conversion method. Must be defined in the inherited classes. This routine converts an element into a user-friendly textual element representing it. The string interpretation of this element is very intuitive by a user, but may be incorrect in the sense that it may be rejected by a checker.
Overrides:
toText in class CoopnElement
Following copied from class: ConForM.CoopnTools.CoKer.CoopnMgr.CoopnElement
Returns:
a CoopnTextElement image.

toCompleteText

public ConForM.CoopnTools.CoKer.CoopnMgr.CoopnTextMgr.CoopnTextElement toCompleteText(CoopnSymbolTable table)
Description copied from class: CoopnElement
Complete textual elements conversion method. Must be defined in the inherited classes. This routine converts an element into a correct textual element representing it. The string interpretation of this element will be accepted by a checker, but may be difficult to read by users, due to the additionnal information, like parenthesis and so on.
Overrides:
toCompleteText in class CoopnElement
Following copied from class: ConForM.CoopnTools.CoKer.CoopnMgr.CoopnElement
Parameters:
table - the symbol table used to generate symbol references
Returns:
a CoopnTextElement image.

toCoco

public ConForM.CoopnTools.CoKer.CoopnMgr.CoopnCocoMgr.CoopnCocoElement toCoco(CoopnSymbolTable table)
                                                                       throws java.lang.IllegalArgumentException
Description copied from class: CoopnElement
CoCo conversion method. Must be defined in the inherited classes. This routine convert an element into a string representing it in a CO-opn COnpact form.
Overrides:
toCoco in class CoopnElement
Following copied from class: ConForM.CoopnTools.CoKer.CoopnMgr.CoopnElement
Parameters:
origin - the module which generated the Coco conversion
table - the symbol table used to generate symbol references
Returns:
a String image of the element.
Throws:
java.lang.IllegalArgumentException - A used symbol is not in the symbol table.

unmodifiableCopy

public java.lang.Object unmodifiableCopy()
Description copied from class: CoopnElement
Copy the element into an unmodifiable structure.
Overrides:
unmodifiableCopy in class CoopnElement
Following copied from class: ConForM.CoopnTools.CoKer.CoopnMgr.CoopnElement
Returns:
an unmodififable clone of the element.

clone

public java.lang.Object clone()
Description copied from class: CoopnElement
Cloning method. Must be defined in the inherited classes.
Overrides:
clone in class CoopnElement
Following copied from class: ConForM.CoopnTools.CoKer.CoopnMgr.CoopnElement
Returns:
a clone object.

intern

public CoopnName intern()
Return a unique instance of an element. Two elements which are equals at a time t returns the same internal element.