ConForM.CoopnTools.CoKer.CoopnMgr
Class CoopnMappingSymbol

java.lang.Object
  |
  +--ConForM.CoopnTools.CoKer.CoopnMgr.CoopnElement
        |
        +--ConForM.CoopnTools.CoKer.CoopnMgr.CoopnSymbol
              |
              +--ConForM.CoopnTools.CoKer.CoopnMgr.CoopnMappingSymbol
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable, CoopnSyntacticElement, CoopnSyntacticSymbol, java.io.Serializable
Direct Known Subclasses:
CoopnMorphismSymbol, CoopnRenameSymbol

public abstract class CoopnMappingSymbol
extends CoopnSymbol

Coopn mapping element.

See Also:
CoopnElement, Serialized Form

Constructor Summary
  CoopnMappingSymbol(CoopnName name, CoopnModuleName module, CoopnName source, CoopnModuleName sourceModule, CoopnName target, CoopnModuleName targetModule)
          Simple constructor.
  CoopnMappingSymbol(CoopnName name, CoopnModuleName module, CoopnName source, CoopnModuleName sourceModule, CoopnName target, CoopnModuleName targetModule, java.lang.String comment)
          Simple constructor.
protected CoopnMappingSymbol(CoopnName name, java.lang.String identifier, CoopnModuleName module, CoopnName source, CoopnModuleName sourceModule, CoopnName target, CoopnModuleName targetModule)
          Simple constructor.
protected CoopnMappingSymbol(CoopnName name, java.lang.String identifier, CoopnModuleName module, CoopnName source, CoopnModuleName sourceModule, CoopnName target, CoopnModuleName targetModule, java.lang.String comment)
          Simple constructor.
 
Method Summary
 java.lang.Object clone()
          Cloning method.
protected abstract  ConForM.CoopnTools.CoKer.CoopnMgr.CoopnCocoMgr.CoopnCocoElement createCocoElement(CoopnName name, java.lang.String identifier, CoopnModuleName module, CoopnName source, CoopnModuleName sourceModule, CoopnName target, CoopnModuleName targetModule)
           
 boolean equals(java.lang.Object obj)
          Equality method.
 boolean equivalent(java.lang.Object obj)
          Equivalence testing method.
 boolean hasSourceModule()
          Test if the function has a source module.
 boolean hasTargetModule()
          Test if the function has a target module.
 CoopnName source()
          Return the source.
 CoopnModuleName sourceModule()
          Return the source module.
 CoopnName target()
          Return the target.
 CoopnModuleName targetModule()
          Return the target module.
 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.
 ConForM.CoopnTools.CoKer.CoopnMgr.CoopnTextMgr.CoopnTextElement toText()
          Textual elements conversion method.
 java.lang.Object unmodifiableCopy()
          Copy the element into an unmodifiable structure.
 
Methods inherited from class ConForM.CoopnTools.CoKer.CoopnMgr.CoopnSymbol
arity, cloneCoopnElement, comment, compareTo, decompose, equalsCoopnSymbol, equivalentCoopnSymbol, hashCode, identifier, indexCoopnSymbol, interpret, kind, module, name, symbolModule, symbolModuleKind, symbolName, toTextCoopnSymbol, unmodifiableSymbol, usedCoopnSymbol
 
Methods inherited from class ConForM.CoopnTools.CoKer.CoopnMgr.CoopnElement
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
 
Methods inherited from interface ConForM.CoopnTools.CoKer.CoopnSyntacticElement
toCompleteString, toCompleteString, toCompleteString, toString, toString, toString
 

Constructor Detail

CoopnMappingSymbol

protected CoopnMappingSymbol(CoopnName name,
                             java.lang.String identifier,
                             CoopnModuleName module,
                             CoopnName source,
                             CoopnModuleName sourceModule,
                             CoopnName target,
                             CoopnModuleName targetModule)
                      throws java.lang.IllegalArgumentException
Simple constructor.

CoopnMappingSymbol

public CoopnMappingSymbol(CoopnName name,
                          CoopnModuleName module,
                          CoopnName source,
                          CoopnModuleName sourceModule,
                          CoopnName target,
                          CoopnModuleName targetModule)
                   throws java.lang.IllegalArgumentException
Simple constructor.

CoopnMappingSymbol

protected CoopnMappingSymbol(CoopnName name,
                             java.lang.String identifier,
                             CoopnModuleName module,
                             CoopnName source,
                             CoopnModuleName sourceModule,
                             CoopnName target,
                             CoopnModuleName targetModule,
                             java.lang.String comment)
                      throws java.lang.IllegalArgumentException
Simple constructor.

CoopnMappingSymbol

public CoopnMappingSymbol(CoopnName name,
                          CoopnModuleName module,
                          CoopnName source,
                          CoopnModuleName sourceModule,
                          CoopnName target,
                          CoopnModuleName targetModule,
                          java.lang.String comment)
                   throws java.lang.IllegalArgumentException
Simple constructor.
Method Detail

source

public CoopnName source()
Return the source.
Returns:
the source

sourceModule

public CoopnModuleName sourceModule()
Return the source module.
Returns:
the source module

target

public CoopnName target()
Return the target.
Returns:
the target

targetModule

public CoopnModuleName targetModule()
Return the target module.
Returns:
the target module

hasSourceModule

public boolean hasSourceModule()
Test if the function has a source module.
Returns:
true iff the function has a source module

hasTargetModule

public boolean hasTargetModule()
Test if the function has a target module.
Returns:
true iff the function has a target module

equals

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

equivalent

public boolean equivalent(java.lang.Object obj)
Description copied from class: CoopnSymbol
Equivalence testing method. This method must be defined in the inherited classes for returning a boolean deciding if this symbol is equivalent to the parameter. Two symbols are equivalents if they are equals, or if they are equals when source modules are not considered. For instance, transition "T" in "Module1" and transition "T" in "Module2" are are not equal, but are equivalent.
Overrides:
equivalent in class CoopnSymbol
Following copied from class: ConForM.CoopnTools.CoKer.CoopnMgr.CoopnSymbol
Returns:
true iff both symbols are equivalents.

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.

createCocoElement

protected abstract ConForM.CoopnTools.CoKer.CoopnMgr.CoopnCocoMgr.CoopnCocoElement createCocoElement(CoopnName name,
                                                                                                     java.lang.String identifier,
                                                                                                     CoopnModuleName module,
                                                                                                     CoopnName source,
                                                                                                     CoopnModuleName sourceModule,
                                                                                                     CoopnName target,
                                                                                                     CoopnModuleName targetModule)

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 interface: CoopnSyntacticElement
Cloning method. Must be defined in the inherited classes.
Overrides:
clone in class CoopnElement
Following copied from interface: ConForM.CoopnTools.CoKer.CoopnSyntacticElement
Returns:
a clone object.