org.objectweb.jorm.metainfo.api
Interface CompositeName

All Superinterfaces:
MetaObject, java.io.Serializable

public interface CompositeName
extends MetaObject

The CompositeName interface defines methods to manage composite name. Composite Name are used to define composite pname. Composite Name defines the multiple fields describing the structure os a name.

Author:
N. De Palma

Method Summary
 void addInheritedCompositeName(CompositeName cn)
          Add an inherited composite name to the current composite name.
 ScalarField createCompositeNameField(java.lang.String fieldname, PType type, int size, int scale)
          Build a new scalarfield that describes a field in the composite name
 java.util.Collection getAllFields()
          Provides an iterator over the field of the current composite name including the inherited fields.
 int getFieldNumber()
          Give the number of fields composing the current composite name.
 java.util.Collection getFields()
          Provides an iterator over the field of the current composite name.
 java.lang.String getFQName()
          Allows to know the fully qualifed name of the current CompositeName object.
 CompositeName getInheritedCompositeName(java.lang.String name)
          Retrieve an inherited composite name form its name.
 int getInheritedCompositeNameNumber()
          Returns the number of inherited composite name for the current composite name object.
 java.lang.String getName()
          Allows to know the name of the current CompositeName object.
 ScalarField getScalarField(java.lang.String fieldname)
          Retrieve a scalarfield describing the field identified by it name in the current compositename.
 java.util.Collection getSuperCompositeNames()
          Provides an iterator over all the composite name inherited by the current composite name.
 java.util.Iterator iterateAllField()
          Deprecated. use getAllFields().
 java.util.Iterator iterateField()
          Deprecated. use getFields().
 java.util.Iterator iterateInheritedCompositeName()
          Deprecated. use getSuperCompositeNames()
 
Methods inherited from interface org.objectweb.jorm.metainfo.api.MetaObject
getParent, setParent
 

Method Detail

getName

public java.lang.String getName()
Allows to know the name of the current CompositeName object.

Returns:
the string representation of the name of the CompositeName

getFQName

public java.lang.String getFQName()
Allows to know the fully qualifed name of the current CompositeName object.

Returns:
the string representation of the name of the CompositeName

addInheritedCompositeName

public void addInheritedCompositeName(CompositeName cn)
Add an inherited composite name to the current composite name.

Parameters:
cn - the name of the composite name to be inherited.

iterateInheritedCompositeName

public java.util.Iterator iterateInheritedCompositeName()
Deprecated. use getSuperCompositeNames()


getSuperCompositeNames

public java.util.Collection getSuperCompositeNames()
Provides an iterator over all the composite name inherited by the current composite name.

Returns:
the iterator embeding inherited composite name objects.

getInheritedCompositeName

public CompositeName getInheritedCompositeName(java.lang.String name)
Retrieve an inherited composite name form its name.

Parameters:
name - the name of the composite name
Returns:
the composite name

getScalarField

public ScalarField getScalarField(java.lang.String fieldname)
Retrieve a scalarfield describing the field identified by it name in the current compositename.

Parameters:
fieldname - the name of the field.
Returns:
the scalarfield describing the field.

getInheritedCompositeNameNumber

public int getInheritedCompositeNameNumber()
Returns the number of inherited composite name for the current composite name object.

Returns:
the number of inherited compositename.

createCompositeNameField

public ScalarField createCompositeNameField(java.lang.String fieldname,
                                            PType type,
                                            int size,
                                            int scale)
Build a new scalarfield that describes a field in the composite name

Parameters:
fieldname - the name of the field
type - the ptype of the field
Returns:
the scalarfield

getFieldNumber

public int getFieldNumber()
Give the number of fields composing the current composite name.

Returns:
the fields number.

iterateField

public java.util.Iterator iterateField()
Deprecated. use getFields().


getFields

public java.util.Collection getFields()
Provides an iterator over the field of the current composite name.

Returns:
the iterator embeding scalarfield object

iterateAllField

public java.util.Iterator iterateAllField()
Deprecated. use getAllFields().


getAllFields

public java.util.Collection getAllFields()
Provides an iterator over the field of the current composite name including the inherited fields.

Returns:
the iterator embeding scalarfield object