org.objectweb.jorm.metainfo.api
Interface ClassProject

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

public interface ClassProject
extends MetaObject, org.objectweb.jorm.util.api.Loggable

A ClassProject object groups together sets of mapping structures resulting from various mappings of a class and its persistent fields over various persistent models. Example: let us consider three different mapping structures. A Client class is first mapped over a relational model. The resulting mapping structures are kept in a Project named "Poseidon". The Client class is once more mapped over a relational model. The resulting mapping structures are kept in a Project named "Corsica". The Client class is later on mapped over a data file model. The resulting mapping structures are kept in the Project named "Poseidon".


Method Summary
 Mapping createMapping(java.lang.String mapperName)
          Creates a new Mapping object using a MappingFactory object.
 Logger getLogger()
          Returns a logger to an component that wants to log things.
 LoggerFactory getLoggerFactory()
          Returns a logger factory that allows the creation of new loggers.
 java.util.Set getMappers()
          Returns a set of mapper names.
 Mapping getMapping(java.lang.String mapperName)
          Returns a Mapping object.
 java.util.Collection getMappings()
          Returns a collection of Mapping objects.
 java.lang.String getProjectName()
          Returns the project name.
 void setLogger(Logger logger)
          Defines a logger object.
 void setLoggerFactory(LoggerFactory loggerFactory)
          Defines the logger factory to obtain new logger.
 void setProjectName(java.lang.String name)
          Sets the project name.
 
Methods inherited from interface org.objectweb.jorm.metainfo.api.MetaObject
getParent, setParent
 

Method Detail

getProjectName

public java.lang.String getProjectName()
Returns the project name.

Returns:
the project name.

setProjectName

public void setProjectName(java.lang.String name)
Sets the project name.

Parameters:
name - the project name.

getMappings

public java.util.Collection getMappings()
Returns a collection of Mapping objects.

Returns:
a collection.

getMapping

public Mapping getMapping(java.lang.String mapperName)
Returns a Mapping object.

Parameters:
mapperName - a mapper name.
Returns:
a collection.

getMappers

public java.util.Set getMappers()
Returns a set of mapper names.

Returns:
a set of mapper names.

createMapping

public Mapping createMapping(java.lang.String mapperName)
Creates a new Mapping object using a MappingFactory object.

Parameters:
mapperName - the name of the mapper.
Returns:
a new Mapping object or an existing one.

setLogger

public void setLogger(Logger logger)
Defines a logger object.

Specified by:
setLogger in interface org.objectweb.jorm.util.api.Loggable
Parameters:
logger - the logger object

setLoggerFactory

public void setLoggerFactory(LoggerFactory loggerFactory)
Defines the logger factory to obtain new logger.

Specified by:
setLoggerFactory in interface org.objectweb.jorm.util.api.Loggable
Parameters:
loggerFactory - the LoggerFactory object to obtain a logger object

getLogger

public Logger getLogger()
Description copied from interface: org.objectweb.jorm.util.api.Loggable
Returns a logger to an component that wants to log things.

Specified by:
getLogger in interface org.objectweb.jorm.util.api.Loggable

getLoggerFactory

public LoggerFactory getLoggerFactory()
Description copied from interface: org.objectweb.jorm.util.api.Loggable
Returns a logger factory that allows the creation of new loggers.

Specified by:
getLoggerFactory in interface org.objectweb.jorm.util.api.Loggable