org.rubato.math.yoneda
Class SimpleForm

java.lang.Object
  extended by org.rubato.math.yoneda.AbstractConnectableYoneda
      extended by org.rubato.math.yoneda.Form
          extended by org.rubato.math.yoneda.SimpleForm
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Form>, Connectable, Yoneda

public final class SimpleForm
extends Form

Simple form class.

Author:
Gérard Milmeister, Stefan Müller, Stefan Göller
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface org.rubato.math.yoneda.Yoneda
COLIMIT, LIMIT, LIST, POWER, SIMPLE
 
Constructor Summary
SimpleForm(NameDenotator name, Module m)
          simple identity form constructor.
SimpleForm(NameDenotator name, Module m, ModuleElement lo, ModuleElement hi)
          simple identity form constructor with a range (for folding).
SimpleForm(NameDenotator name, Morphism identifier)
          Generic simple form constructor.
 
Method Summary
 Denotator createDefaultDenotator()
          Returns a default denotator of this simple form.
 Denotator createDefaultDenotator(Module address)
          Returns a default denotator of this simple form with the given address.
 boolean equals(java.lang.Object object)
          Returns true iff this form is equal to the specified object.
 boolean equals(SimpleForm f)
           
static SimpleForm fromXML(XMLReader reader, org.w3c.dom.Element element)
          Reads XML representation from reader starting with element.
 boolean fullEquals(SimpleForm f)
           
 boolean fullEquals(SimpleForm f, java.util.IdentityHashMap<java.lang.Object,java.lang.Object> s)
           
 Form getForm(int i)
          Returns a coordinate form.
 int getFormCount()
          Returns the number of coordinate forms.
 Module getModule()
          Returns the module of this simple form.
 int getType()
          Returns the type of the form.
 boolean iscomplete()
           
 java.lang.String toString()
          Returns a string representation of this form.
 void toXML(XMLWriter writer)
           
 
Methods inherited from class org.rubato.math.yoneda.Form
_register, clone, compareTo, display, display, equals, fullEquals, fullEquals, getDependencies, getDimension, getDimension, getForms, getIdentifier, getName, getNameString, getTypeString, hashCode, isRegistered, resolveReferences, setIdentifier, setName, setName, stringToType, typeToString
 
Methods inherited from class org.rubato.math.yoneda.AbstractConnectableYoneda
getConnector, setConnector
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SimpleForm

public SimpleForm(NameDenotator name,
                  Morphism identifier)
Generic simple form constructor.


SimpleForm

public SimpleForm(NameDenotator name,
                  Module m)
simple identity form constructor.


SimpleForm

public SimpleForm(NameDenotator name,
                  Module m,
                  ModuleElement lo,
                  ModuleElement hi)
simple identity form constructor with a range (for folding).

Method Detail

getType

public int getType()
Returns the type of the form.

Specified by:
getType in class Form

equals

public boolean equals(java.lang.Object object)
Description copied from class: Form
Returns true iff this form is equal to the specified object.

Specified by:
equals in class Form

equals

public boolean equals(SimpleForm f)

fullEquals

public boolean fullEquals(SimpleForm f)

fullEquals

public boolean fullEquals(SimpleForm f,
                          java.util.IdentityHashMap<java.lang.Object,java.lang.Object> s)

iscomplete

public boolean iscomplete()

getFormCount

public int getFormCount()
Returns the number of coordinate forms.

Specified by:
getFormCount in class Form

getForm

public Form getForm(int i)
Returns a coordinate form.

Specified by:
getForm in class Form
Parameters:
i - the coordinate position
Returns:
the form at coordinate position i

createDefaultDenotator

public Denotator createDefaultDenotator()
Returns a default denotator of this simple form.

Specified by:
createDefaultDenotator in class Form

createDefaultDenotator

public Denotator createDefaultDenotator(Module address)
Returns a default denotator of this simple form with the given address.

Specified by:
createDefaultDenotator in class Form

getModule

public Module getModule()
Returns the module of this simple form.


toXML

public void toXML(XMLWriter writer)
Specified by:
toXML in class Form

fromXML

public static SimpleForm fromXML(XMLReader reader,
                                 org.w3c.dom.Element element)
Reads XML representation from reader starting with element.

Returns:
a simple form or null if parsing failed

toString

public java.lang.String toString()
Description copied from class: Form
Returns a string representation of this form. This string is not parseable and does not contain all information. It is only meant for information purposes.

Specified by:
toString in class Form