org.objectweb.jorm.api

Interface PMappingStructuresManager

Known Subinterfaces:
PMapper, PMappingCallback

public interface PMappingStructuresManager

Defines the way to access the map clusters used to define and instanciate the mapping structures.

Author:
P. Dechamboux

Method Summary

void
addDependency(String jcname1, String jcname2)
Adds a dependency between a defined class and another class.
void
classDefined(String jcname)
Indicates that a jorm class is defined.
void
declareClass(String jcname)
Declares a persistent class.
PMapCluster
getPMapCluster(String jcname)
Asks for the map cluster associated with a JORM class.
Collection
getPMapClusters()
Asks for all the map clusters defined within this mapper.
void
setLogger(Logger l)
Assigns a logger to this schema manager.
void
setPMapper(PMapper pm)
Assigns a mapper to this schema manager.

Method Details

addDependency

public void addDependency(String jcname1,
                          String jcname2)
            throws PException
Adds a dependency between a defined class and another class.

Parameters:
jcname1 - is the class name of a defined class
jcname2 - is the name of the class which the first depends on it.

Throws:
PException - if the first jorm class name is not defined (no cluster found)


classDefined

public void classDefined(String jcname)
            throws PException
Indicates that a jorm class is defined.

Parameters:
jcname - which is defined.


declareClass

public void declareClass(String jcname)
Declares a persistent class. This call crerates the PMapCluster.

Parameters:
jcname -


getPMapCluster

public PMapCluster getPMapCluster(String jcname)
            throws PException
Asks for the map cluster associated with a JORM class.

Parameters:
jcname - The JORM class name.

Returns:
The relevant map cluster.

Throws:
PException - This class has not been mapped.


getPMapClusters

public Collection getPMapClusters()
Asks for all the map clusters defined within this mapper.

Returns:
The Iterator over the collection of map clusters.


setLogger

public void setLogger(Logger l)
Assigns a logger to this schema manager.

Parameters:
l - The concerned logger.


setPMapper

public void setPMapper(PMapper pm)
Assigns a mapper to this schema manager.

Parameters:
pm - The concerned mapper.