org.objectweb.jorm.metainfo.api
Interface Mapping

All Superinterfaces:
MetaObject, java.io.Serializable

public interface Mapping
extends MetaObject

A Mapping object contains mapping structures obtained by applying a set of mapping rules whose syntax and semantics depend of a particular mapper. Mapping rules define the way class instances will be stored on a particular type of persistent store and how they will be read and write from/to the persistent store.


Method Summary
 void addGenClassMapping(java.lang.String genClassId, GenClassMapping genClassMapping)
          Adds a GenClassMapping object.
 ClassMapping createClassMapping(java.lang.String ruleName)
          Create a class mapping
 ClassMapping getClassMapping()
          Returns the mapping structure of the class.
 GenClassMapping getGenClassMapping(java.lang.String genclassid)
          Returns the GenClassMapping object of a GenClass.
 java.util.Collection getGenClassMappings()
          Returns a collection of GenClassMapping objects.
 java.lang.String getMapperName()
          Returns the name of the mapper.
 void setClassMapping(ClassMapping classMapping)
          Sets the mapping structure of the class.
 void setMapperName(java.lang.String mapperName)
          Sets the mapper name.
 
Methods inherited from interface org.objectweb.jorm.metainfo.api.MetaObject
getParent, setParent
 

Method Detail

getMapperName

public java.lang.String getMapperName()
Returns the name of the mapper.

Returns:
the mapper name.

setMapperName

public void setMapperName(java.lang.String mapperName)
Sets the mapper name.

Parameters:
mapperName - the mapper name.

getClassMapping

public ClassMapping getClassMapping()
Returns the mapping structure of the class.

Returns:
a ClassMapping object.

setClassMapping

public void setClassMapping(ClassMapping classMapping)
Sets the mapping structure of the class.

Parameters:
classMapping - a ClassMapping object.

getGenClassMapping

public GenClassMapping getGenClassMapping(java.lang.String genclassid)
Returns the GenClassMapping object of a GenClass.

Parameters:
genclassid - a GenClass identifier.
Returns:
a GenClassMapping object.

getGenClassMappings

public java.util.Collection getGenClassMappings()
Returns a collection of GenClassMapping objects.

Returns:
a collection.

addGenClassMapping

public void addGenClassMapping(java.lang.String genClassId,
                               GenClassMapping genClassMapping)
Adds a GenClassMapping object.

Parameters:
genClassId - a GenClass identifier, genClassMapping a GenClassMapping object.

createClassMapping

public ClassMapping createClassMapping(java.lang.String ruleName)
Create a class mapping

Parameters:
ruleName -
Returns: