|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
It defines a manager of a type of naming. This interface covers needs at compile time and at run time. In particular a naming manager is able to fill the Speedo meta information with the particularity of the a naming.
Nested Class Summary | |
---|---|
static class |
NamingManager.NamingField
Defines the field used in an identifier and which must be set at makePersistent time. |
Field Summary | |
---|---|
static java.lang.String |
SEP
|
Method Summary | |
---|---|
boolean |
canManage(SpeedoClass sc)
Indicates if the naming manager is able to manage the identifier of a persistent class. |
boolean |
canProvidePBinder(java.lang.Object hints,
java.lang.ClassLoader classLoader)
indicates if the naming manager is able to build a PBinder instance for this hints parameter specified |
boolean |
canProvidePNamingContext(java.lang.Object hints,
java.lang.ClassLoader classLoader)
indicates if the naming manager is able to build a PNC instance for this hints parameter specified |
org.objectweb.jorm.naming.api.PName |
decode(org.objectweb.jorm.naming.api.PNameCoder pnc,
java.lang.Object oid,
java.lang.Class clazz,
JormFactory jf)
Decodes an object identifier into a PName. |
java.lang.Object |
encode(org.objectweb.jorm.naming.api.PName pn)
Encode a PName into an object |
void |
fillNameDef(MIBuilderHelper mibh,
org.objectweb.jorm.metainfo.api.Manager manager,
org.objectweb.jorm.metainfo.api.NameDef nd,
SpeedoClass tsc,
SpeedoClass ssc,
org.objectweb.jorm.metainfo.api.MetaObject mo,
org.objectweb.jorm.metainfo.api.Reference ref,
org.objectweb.jorm.metainfo.api.CommonClassMapping hcm,
JormMIMappingBuilder mb,
boolean isIdentifier,
boolean isInGenClass,
boolean createField,
java.util.Collection createdMOs)
Fill the name def of an identifier or a reference |
java.lang.String |
getGCPNameHints(SpeedoClass sc,
org.objectweb.jorm.metainfo.api.NameDef nd)
compute a string value which permit to help the building of the genclass PName (export) |
void |
getJormNamingConfig(org.objectweb.jorm.metainfo.api.NameDef nd,
SpeedoClass targetClass,
org.objectweb.jorm.metainfo.api.MetaObject sourceMO,
java.lang.String key,
java.util.Properties result)
computes the naming configuration information for a class or a reference. |
NamingManager.NamingField[] |
getNamingfields(SpeedoClass sc)
Retrieves the array of field used in the identifier of a persistent class and which values are not calculated by the application. |
org.objectweb.jorm.naming.api.PBinder |
getPBinder(java.lang.String className,
java.lang.String hints,
java.lang.ClassLoader classLoader,
byte mappingStructureRule,
java.util.Map cn2binder,
java.util.Map cn2pnc)
Build a PBinder instance for this hints parameter specified |
java.lang.String |
getPNameHints(SpeedoClass sc,
org.objectweb.jorm.metainfo.api.NameDef nd)
compute a string value which permit to help the building of the class PName (export) |
org.objectweb.jorm.naming.api.PNamingContext |
getPNamingContext(java.lang.String className,
java.lang.String hints,
java.lang.ClassLoader classLoader,
byte mappingStructureRule,
java.util.Map cn2binder,
java.util.Map cn2pnc,
org.objectweb.jorm.metainfo.api.Manager miManager,
org.objectweb.jorm.api.PClassMapping pcm)
Build a PNamingContext instance for this hints parameter specified |
void |
setCache(org.objectweb.perseus.cache.api.CacheManager cache)
|
void |
setLogger(org.objectweb.util.monolog.api.Logger logger)
|
void |
setPMapper(org.objectweb.jorm.api.PMapper mapper)
|
void |
setPmf(ProxyManagerFactory pmf)
|
boolean |
supportPNamingcontext()
indicates if the use of PNamingContext is support by this mapping. |
Field Detail |
public static final java.lang.String SEP
Method Detail |
public boolean canManage(SpeedoClass sc)
sc
- The speedo meta object representing the persistent classpublic boolean canProvidePBinder(java.lang.Object hints, java.lang.ClassLoader classLoader)
hints
- is the helper of the PBinder buildingclassLoader
- is the classloader to use for instanciate the PBinderpublic boolean canProvidePNamingContext(java.lang.Object hints, java.lang.ClassLoader classLoader)
hints
- is the helper of the PNC buildingclassLoader
- is the classloader to use for instanciate the PNCpublic org.objectweb.jorm.naming.api.PBinder getPBinder(java.lang.String className, java.lang.String hints, java.lang.ClassLoader classLoader, byte mappingStructureRule, java.util.Map cn2binder, java.util.Map cn2pnc) throws org.objectweb.jorm.api.PException
hints
- is the helper of the PBinder building. This hints must be
the result of the getJormConfig call.classLoader
- is the classloader to use for instanciate the PBindermappingStructureRule
- indicates the rule to apply concerning the
data strucuture. Indeed a PBinder building can require to read the data
support.cn2binder
- is the map of the existing PBinder instance
(key = class name, value = PBinder instance)cn2pnc
- is the map of the existing PNC instance
(key = class name, value = PNC instance)
org.objectweb.jorm.api.PException
public org.objectweb.jorm.naming.api.PNamingContext getPNamingContext(java.lang.String className, java.lang.String hints, java.lang.ClassLoader classLoader, byte mappingStructureRule, java.util.Map cn2binder, java.util.Map cn2pnc, org.objectweb.jorm.metainfo.api.Manager miManager, org.objectweb.jorm.api.PClassMapping pcm) throws org.objectweb.jorm.api.PException
hints
- is the helper of the PBinder building. This hints must be
the result of the getJormConfig call.classLoader
- is the classloader to use for instanciate the PBindermappingStructureRule
- indicates the rule to apply concerning the
data strucuture. Indeed a PBinder building can require to read the data
support.cn2binder
- is the map of the existing PBinder instance
(key = class name, value = PBinder instance)cn2pnc
- is the map of the existing PNC instance
(key = class name, value = PNC instance)
org.objectweb.jorm.api.PException
public org.objectweb.jorm.naming.api.PName decode(org.objectweb.jorm.naming.api.PNameCoder pnc, java.lang.Object oid, java.lang.Class clazz, JormFactory jf) throws org.objectweb.jorm.api.PException
pnc
- is the PNameCoder instance to use for the decoding the object
identifier. The pnc parameter can be null. In this case the oid mustoid
- is the object identifierclazz
- is the java.lang.Class of the persistent class identified by
the oidjf
- is the JormFactory instance. It permits to
org.objectweb.jorm.api.PException
public java.lang.Object encode(org.objectweb.jorm.naming.api.PName pn) throws org.objectweb.jorm.api.PException
pn
- is the pname to encode
org.objectweb.jorm.api.PException
public boolean supportPNamingcontext()
public void fillNameDef(MIBuilderHelper mibh, org.objectweb.jorm.metainfo.api.Manager manager, org.objectweb.jorm.metainfo.api.NameDef nd, SpeedoClass tsc, SpeedoClass ssc, org.objectweb.jorm.metainfo.api.MetaObject mo, org.objectweb.jorm.metainfo.api.Reference ref, org.objectweb.jorm.metainfo.api.CommonClassMapping hcm, JormMIMappingBuilder mb, boolean isIdentifier, boolean isInGenClass, boolean createField, java.util.Collection createdMOs) throws SpeedoException, org.objectweb.jorm.api.PException
nd
- is the name def to fillisIdentifier
- indicates if the name represents an identifier (true)
or a reference (false).isInGenClass
- indicates if the name is defined in a generic class
(true) of in a class (false).ref
- meta object which the name def must be
defined. This value is used only in the case of isIdentifier == false and
isInGenClass == false.tsc
- is the speedo meta object representing the referenced class.
This value is used only in the case of isIdentifier == false.mo
- is the jorm meta object hosting the name def and on which the
eventual hidden field will be created.hcm
- if the mapping structure hosting the mapping of the reference.
This value must be ClassMapping or GenClassMapping instance.mb
- is the mapping builder permitting the creation of the mapping
part.createdMOs
- is a result paramter. This collection must be fill with
the created Jorm Meta objects representing a class or a composite name.
Here only the new used composite name will be added.
SpeedoException
- if the speedo meta information is not completly
defined.
org.objectweb.jorm.api.PException
public void getJormNamingConfig(org.objectweb.jorm.metainfo.api.NameDef nd, SpeedoClass targetClass, org.objectweb.jorm.metainfo.api.MetaObject sourceMO, java.lang.String key, java.util.Properties result) throws SpeedoException
naming of a/td> | MOClass/td> |
class/td> | Class/td> |
reference to a Class/td> | ClassRef/td> |
reference to a GenClass/td> | GenClassRef/td> |
a GenClass identifier/td> | GenClassRef/td> |
targetClass
- is the Speedo meta object representing the class which
is designates by theresult
- is the Properties which must be filled
SpeedoException
public java.lang.String getPNameHints(SpeedoClass sc, org.objectweb.jorm.metainfo.api.NameDef nd)
sc
- is the Speedo class which the hints must be specifiednd
- is the name def of the classpublic java.lang.String getGCPNameHints(SpeedoClass sc, org.objectweb.jorm.metainfo.api.NameDef nd)
sc
- is the Speedo class which the hints must be specifiednd
- is the name def of the gen classpublic void setPMapper(org.objectweb.jorm.api.PMapper mapper) throws org.objectweb.jorm.api.PException
org.objectweb.jorm.api.PException
public void setLogger(org.objectweb.util.monolog.api.Logger logger)
public void setCache(org.objectweb.perseus.cache.api.CacheManager cache)
public void setPmf(ProxyManagerFactory pmf)
public NamingManager.NamingField[] getNamingfields(SpeedoClass sc) throws org.objectweb.jorm.api.PException
sc
- is the speedo meta object of the persistent class
org.objectweb.jorm.api.PException
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |