org.objectweb.jorm.metainfo.api

Interface CompositeName

All Superinterfaces:
MetaObject, 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(String fieldname, PType type, int size, int scale)
Build a new scalarfield that describes a field in the composite name
Collection
getAllFields()
Provides an iterator over the field of the current composite name including the inherited fields.
String
getFQName()
Allows to know the fully qualifed name of the current CompositeName object.
int
getFieldNumber()
Give the number of fields composing the current composite name.
Collection
getFields()
Provides an iterator over the field of the current composite name.
CompositeName
getInheritedCompositeName(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.
String
getName()
Allows to know the name of the current CompositeName object.
ScalarField
getScalarField(String fieldname)
Retrieve a scalarfield describing the field identified by it name in the current compositename.
Collection
getSuperCompositeNames()
Provides an iterator over all the composite name inherited by the current composite name.
Iterator
iterateAllField()
Deprecated. use getAllFields().
Iterator
iterateField()
Deprecated. use getFields().
Iterator
iterateInheritedCompositeName()
Deprecated. use getSuperCompositeNames()

Methods inherited from interface org.objectweb.jorm.metainfo.api.MetaObject

getParent, setParent

Method Details

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.


createCompositeNameField

public ScalarField createCompositeNameField(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


getAllFields

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

Returns:
the iterator embeding scalarfield object


getFQName

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

Returns:
the string representation of the name of the CompositeName


getFieldNumber

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

Returns:
the fields number.


getFields

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

Returns:
the iterator embeding scalarfield object


getInheritedCompositeName

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

Parameters:
name - the name of the composite name

Returns:
the composite name


getInheritedCompositeNameNumber

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

Returns:
the number of inherited compositename.


getName

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

Returns:
the string representation of the name of the CompositeName


getScalarField

public ScalarField getScalarField(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.


getSuperCompositeNames

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

Returns:
the iterator embeding inherited composite name objects.


iterateAllField

public Iterator iterateAllField()

Deprecated. use getAllFields().


iterateField

public Iterator iterateField()

Deprecated. use getFields().


iterateInheritedCompositeName

public Iterator iterateInheritedCompositeName()

Deprecated. use getSuperCompositeNames()