org.objectweb.jorm.interp.genclass.fos.lib
Class FosGenClassMapping

java.lang.Object
  |
  +--org.objectweb.jorm.interp.genclass.lib.GenClassMapping
        |
        +--org.objectweb.jorm.interp.genclass.fos.lib.FosGenClassMapping

All Implemented Interfaces:

FosGenClassProp, GenClassProp, Loggable, PClassMapping

public class FosGenClassMapping

extends GenClassMapping

implements FosGenClassProp

Inner classes inherited from class org.objectweb.jorm.api.PClassMapping

PClassMapping.ReferenceConfigurator

Field Summary

protected java.lang.String	className
protected java.lang.String	dirName
protected java.lang.String	fieldName
protected int	genClassLevel

Fields inherited from class org.objectweb.jorm.interp.genclass.lib.GenClassMapping

binder, elemClassMapping, elemCodingOnly, elemFields, elemNamingContext, genClassMetaInfo, genClassPType, identifierFields, indexFields, logger, loggerFactory, mapper

Fields inherited from interface org.objectweb.jorm.api.PClassMapping

CLEANUP_DONOTHING, CLEANUP_REMOVEALL, CLEANUP_REMOVEDATA, CREATE_STRUCTURE_IF_NEEDED

Constructor Summary

FosGenClassMapping()

Method Summary

PBinding	createPBinding() It creates a new PBinding.
java.util.Iterator	getPNameIterator(java.lang.Object conn) It returns an iterator over all pname of persitent objects availlable in this class.
void	initMappingStructures(java.lang.Object conn, byte cleanup) It initializes the persistent structures required to map a JORM class within a particular Data Store.
boolean	isConform(java.lang.String mappername) It specifies if the given kind of PMapper is supported by this PClassMapping.
void	removeMappingStructures(java.lang.Object conn, boolean contentonly) It removes the persistent structures required to map a JORM class within a particular Data Store.
void	setClassName(java.lang.String cn) Specifies the class within which the related generic class is defined.
void	setFieldName(java.lang.String fn) Specifies the field of the class which defines the related generic class.
void	setGenClassLevel(int level) Specifies the level of names of the related generic class (e.g., for a set of lists, lists are level 0).

Methods inherited from class org.objectweb.jorm.interp.genclass.lib.GenClassMapping

configureRefFields, getClassName, getElemFields, getGenClassMapping, getGenClassMapping, getIdentifierFields, getIndexFields, getLogger, getLoggerFactory, getMetaInfo, getPBinder, getPMapper, getPNameManager, getPNameManager, getPType, init, setElemDesc, setGcType, setGenClassMapping, setGenClassMapping, setIdentifierDesc, setIndexDesc, setLogger, setLoggerFactory, setPBinder, setPNamingContext, setPNamingContext, setPType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.objectweb.jorm.interp.genclass.api.GenClassProp

setElemDesc, setGcType, setIdentifierDesc, setIndexDesc

Field Detail

className

protected java.lang.String className

fieldName

protected java.lang.String fieldName

genClassLevel

protected int genClassLevel

dirName

protected java.lang.String dirName

Constructor Detail

FosGenClassMapping

public FosGenClassMapping()

Method Detail

createPBinding

public PBinding createPBinding()
                        throws PException

It creates a new PBinding.

Returns:

The new PBinding with lifecycle state set to LIFECYCLE_NOTBOUND.

getPNameIterator

public java.util.Iterator getPNameIterator(java.lang.Object conn)
                                    throws PException

It returns an iterator over all pname of persitent objects availlable in this class.

Parameters:

conn - is the connection which permits to access to the support

Returns:

the iterator over PName objects

Throws:

PExceptionProtocol - A problem occured during the request that is not related to I/O.

PExceptionIO - A problem occured during the request.

initMappingStructures

public void initMappingStructures(java.lang.Object conn,
                                  byte cleanup)
                           throws PExceptionProtocol,
                                  PExceptionIO

It initializes the persistent structures required to map a JORM class within a particular Data Store. This method has no effect when the structures already exist, or when the structure must not be manipulated via JORM (e.g., case of a legacy DS). The deletion of these structures may be requested before initializing them.

Parameters:

conn - The connection that can be used to access the DS.

cleanup - Tells if structures and/or data should be removed at initialization time.

Throws:

PExceptionProtocol - A problem occured during initialisation that is not related to I/O.

PExceptionIO - A problem occured during the initialization of the DS.

isConform

public boolean isConform(java.lang.String mappername)

It specifies if the given kind of PMapper is supported by this PClassMapping.

Parameters:

mappername - The name defining the PMapper kind.

Returns:

true if this kind of mapper is supported.

removeMappingStructures

public void removeMappingStructures(java.lang.Object conn,
                                    boolean contentonly)
                             throws PExceptionProtocol,
                                    PExceptionIO

It removes the persistent structures required to map a JORM class within a particular Data Store. This method has no effect when the structures do not exist, or when the structure must not be manipulated via JORM (e.g., case of a legacy DS).

Parameters:

conn - The connection that can be used to access the DS.

contentonly - It specifies if only the content of the persistent structures should be removed (it only removes data).

Throws:

PExceptionProtocol - A problem occured during the deletion that is not related to I/O.

PExceptionIO - A problem occured during the deletion of the DS.

setClassName

public void setClassName(java.lang.String cn)

Description copied from interface: FosGenClassProp

Specifies the class within which the related generic class is defined.

Specified by:

setClassName in interface FosGenClassProp

setFieldName

public void setFieldName(java.lang.String fn)

Description copied from interface: FosGenClassProp

Specifies the field of the class which defines the related generic class.

Specified by:

setFieldName in interface FosGenClassProp

setGenClassLevel

public void setGenClassLevel(int level)

Description copied from interface: FosGenClassProp

Specifies the level of names of the related generic class (e.g., for a set of lists, lists are level 0).

Specified by:

setGenClassLevel in interface FosGenClassProp