org.objectweb.jorm.metainfo.api
Interface HelperClassMapping

All Superinterfaces:
org.objectweb.jorm.util.api.Loggable, MappingStructure, MetaObject, java.io.Serializable
All Known Subinterfaces:
ClassMapping, GenClassMapping

public interface HelperClassMapping
extends MappingStructure

todo: Description


Method Summary
 void addDependency(java.lang.String jormClassName)
           
 void addPrimitiveElementMapping(PrimitiveElementMapping pemapping)
          Adds a PrimitiveElementMapping object.
 void addPrimitiveElementMapping(java.lang.String fieldName, PrimitiveElementMapping pemapping)
          Adds a PrimitiveElementMapping object.
 IdentifierMapping createIdentifierMapping(NameDef nd)
          Creates a new IdentifierMapping object.
 ReferenceMapping createReferenceMapping(java.lang.String ruleName, NameDef nd)
          Creates a new ReferenceMapping object.
 java.util.Collection getDependencies()
           
 IdentifierMapping getIdentifierMapping()
          Returns the IdentifierMapping object.
 PrimitiveElementMapping getPrimitiveElementMapping(java.lang.String fieldName)
          Returns the PrimitiveElementMapping objects matching to the fieldName specified.
 java.util.Collection getPrimitiveElementMappings()
          Returns a collection of PrimitiveElementMapping objects.
 java.lang.String getRuleName()
          Returns the name of the rule used to map the class.
 java.util.Iterator iteratePrimitiveElementMappings()
          Returns an Iterator over PrimitiveElementMapping objects.
 void removeDependency(java.lang.String jormClassName)
           
 void setIdentifierMapping(IdentifierMapping idmapping)
          Sets the IdentifierMapping object.
 void setRuleName(java.lang.String rulename)
          Sets the name of the rule used to map the class.
 
Methods inherited from interface org.objectweb.jorm.metainfo.api.MappingStructure
getLinkedMO, getLogger, getLoggerFactory, getMapperName, getProjectName, setLinkedMO, setLogger, setLoggerFactory
 
Methods inherited from interface org.objectweb.jorm.metainfo.api.MetaObject
getParent, setParent
 

Method Detail

getRuleName

public java.lang.String getRuleName()
Returns the name of the rule used to map the class.

Returns:
the name of the rule.

setRuleName

public void setRuleName(java.lang.String rulename)
Sets the name of the rule used to map the class.

Parameters:
rulename - the name of the rule.

getIdentifierMapping

public IdentifierMapping getIdentifierMapping()
Returns the IdentifierMapping object.

Returns:
an IdentifierMapping object.

setIdentifierMapping

public void setIdentifierMapping(IdentifierMapping idmapping)
Sets the IdentifierMapping object.

Parameters:
idmapping - the IdentifierMapping object.

getPrimitiveElementMappings

public java.util.Collection getPrimitiveElementMappings()
Returns a collection of PrimitiveElementMapping objects.

Returns:
a collection.

getPrimitiveElementMapping

public PrimitiveElementMapping getPrimitiveElementMapping(java.lang.String fieldName)
Returns the PrimitiveElementMapping objects matching to the fieldName specified.

Parameters:
fieldName - is a name of a primitivite field (hidden or not) of the class
Returns:
a collection.

addPrimitiveElementMapping

public void addPrimitiveElementMapping(PrimitiveElementMapping pemapping)
Adds a PrimitiveElementMapping object.

Parameters:
pemapping - the PrimitiveElementMapping object to add to the list.

addPrimitiveElementMapping

public void addPrimitiveElementMapping(java.lang.String fieldName,
                                       PrimitiveElementMapping pemapping)
Adds a PrimitiveElementMapping object.

Parameters:
pemapping - the PrimitiveElementMapping object to add to the list.

iteratePrimitiveElementMappings

public java.util.Iterator iteratePrimitiveElementMappings()
Returns an Iterator over PrimitiveElementMapping objects.

Returns:
an Iterator.

createIdentifierMapping

public IdentifierMapping createIdentifierMapping(NameDef nd)
Creates a new IdentifierMapping object.

Parameters:
nd - the NameDef object that defines an object identifier.
Returns:
an IdentifierMapping object.

createReferenceMapping

public ReferenceMapping createReferenceMapping(java.lang.String ruleName,
                                               NameDef nd)
Creates a new ReferenceMapping object.

Parameters:
ruleName - the name of the rule used to map the reference, nd the NameDef object that defines an object reference.
Returns:
a ReferenceMapping object.

addDependency

public void addDependency(java.lang.String jormClassName)

removeDependency

public void removeDependency(java.lang.String jormClassName)

getDependencies

public java.util.Collection getDependencies()