org.objectweb.jorm.metainfo.api
Interface ClassMapping

All Superinterfaces:
HelperClassMapping, org.objectweb.jorm.util.api.Loggable, MappingStructure, MetaObject, java.io.Serializable

public interface ClassMapping
extends HelperClassMapping

The ClassMapping interface defines methods to describe how a class is mapped into JORM.

Author:
X. Spengler

Method Summary
 void addReferenceMapping(ReferenceMapping refMapping)
          Adds a ReferenceMapping object.
 ReferenceMapping getReferenceMapping(java.lang.String referenceName)
          Retrieves the ReferenceMapping instance corresponding to the name of a reference field.
 java.util.Collection getReferenceMappings()
          Returns a collection of ReferenceMapping objects.
 java.util.Iterator iterateReferenceMappings()
          Returns an Iterator over ReferenceMapping objects.
 
Methods inherited from interface org.objectweb.jorm.metainfo.api.HelperClassMapping
addDependency, addPrimitiveElementMapping, addPrimitiveElementMapping, createIdentifierMapping, createReferenceMapping, getDependencies, getIdentifierMapping, getPrimitiveElementMapping, getPrimitiveElementMappings, getRuleName, iteratePrimitiveElementMappings, removeDependency, setIdentifierMapping, setRuleName
 
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

addReferenceMapping

public void addReferenceMapping(ReferenceMapping refMapping)
Adds a ReferenceMapping object.

Parameters:
refMapping - the ReferenceMapping object to add to the list.

getReferenceMapping

public ReferenceMapping getReferenceMapping(java.lang.String referenceName)
Retrieves the ReferenceMapping instance corresponding to the name of a reference field.

Parameters:
referenceName - is the name of a reference field
Returns:
a ReferenceMapping instance or a null value if no mapping is defined for the reference name

iterateReferenceMappings

public java.util.Iterator iterateReferenceMappings()
Returns an Iterator over ReferenceMapping objects.

Returns:
an Iterator.

getReferenceMappings

public java.util.Collection getReferenceMappings()
Returns a collection of ReferenceMapping objects.

Returns:
a collection.