| org.objectweb.speedo.naming.api.NamingManager
All known Subclasses: org.objectweb.speedo.naming.lib.RdbSequenceNamingManager, org.objectweb.speedo.naming.lib.NamingManagerHelper, org.objectweb.speedo.naming.lib.UserIdCompositeNamingManager, org.objectweb.speedo.naming.lib.UserIdSingleNamingManager, org.objectweb.speedo.naming.lib.PolymorphIdNamingManager,
| NamingManager | | public interface NamingManager (Code) | | 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.
author:
S.Chassande-Barrioz |
| Inner Class :public class NamingField | |
| Method Summary | |
| boolean | canManage(SpeedoClass sc)
Indicates if the naming manager is able to manage the identifier of a
persistent class. | | boolean | canProvidePBinder(Object hints, ClassLoader classLoader)
| | boolean | canProvidePNamingContext(Object hints, ClassLoader classLoader)
| | PName | decode(PNameCoder pnc, Object oid, java.lang.Class clazz, JormFactory jf)
Decodes an object identifier into a PName.
Parameters:
pnc - is the PNameCoder instance to use for the decoding the objectidentifier. | | void | defineClassIdentifierNameDef(NameDef nd, Class jc, SpeedoClass sc, ClassMapping cm, MIBuilderHelper mibh, JormMIMappingBuilder mb, Collection createdMOs)
Fill the name def of a class identifier
Parameters:
nd - is the name def to fill
Parameters:
sc - is the speedo meta object representing the class.
Parameters:
jc - is the jorm meta object representing the class.
Parameters:
cm - if the mapping structure hosting the mapping of the class.
Parameters:
mibh - is a helper for the management of the JORM meta info
Parameters:
mb - is the mapping builder permitting the creation of the mappingobjects.
Parameters:
createdMOs - is a result paramter. | | void | defineClassReferenceNameDef(NameDef nd, ClassRef cr, SpeedoField sf, SpeedoClass currentClass, ClassMapping cm, MIBuilderHelper mibh, JormMIMappingBuilder mb)
| | void | defineClassReferenceNameDef(NameDef nd, ClassRef cr, SpeedoField sf, SpeedoClass currentClass, GenClassMapping gcm, MIBuilderHelper mibh, JormMIMappingBuilder mb)
Fill the name def of the class reference from a generic class
Parameters:
nd - is the name def to fill
Parameters:
cr - is the speedo meta object representing the class.
Parameters:
sf - is the speedo meta object representing the persistent reference to a class.
Parameters:
currentClass - is the class mapping the field
Parameters:
gcm - if the mapping structure hosting the mapping of the class.
Parameters:
mibh - is a helper for the management of the JORM meta info
Parameters:
mb - is the mapping builder permitting the creation of the mappingobjects.
Parameters:
createdMOs - is a result paramter. | | void | defineGenClassIdentifierNameDef(NameDef nd, GenClassRef gcr, SpeedoField sf, SpeedoClass currentClass, GenClassMapping gcm, MIBuilderHelper mibh, JormMIMappingBuilder mb)
| | void | defineGenClassReferenceNameDef(NameDef nd, GenClassRef gcr, SpeedoField sf, SpeedoClass currentClass, ClassMapping cm, MIBuilderHelper mibh, JormMIMappingBuilder mb)
| | Object | encode(PName pn)
| | SpeedoColumn[] | getDefaultColumn(SpeedoClass sc)
| | String | getGCPNameHints(SpeedoClass sc, NameDef nd)
| | void | getJormNamingConfig(NameDef nd, SpeedoClass targetClass, MetaObject sourceMO, String key, Properties result)
computes the naming configuration information for a class or a reference.
This information is store as a String. | | 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. | | PBinder | getPBinder(String className, String hints, ClassLoader classLoader, byte mappingStructureRule, Map cn2binder, Map cn2pnc)
Build a PBinder instance for this hints parameter specified
Parameters:
hints - is the helper of the PBinder building. | | String | getPNameHints(SpeedoClass sc, NameDef nd)
| | Object[] | getPNameHints2(SpeedoClass sc, NameDef nd)
| | PNamingContext | getPNamingContext(String className, String hints, ClassLoader classLoader, byte mappingStructureRule, Map cn2binder, Map cn2pnc, Manager miManager, PClassMapping pcm)
Build a PNamingContext instance for this hints parameter specified
Parameters:
hints - is the helper of the PBinder building. | | boolean | needInheritanceDiscriminator(SpeedoClass sc)
| | void | setCache(CacheManager cache)
| | void | setLogger(Logger logger)
| | void | setPMapper(PMapper mapper)
| | void | setPmf(POManagerFactoryItf pmf)
| | boolean | supportPNamingcontext()
indicates if the use of PNamingContext is support by this mapping. |
| canManage | | boolean canManage(SpeedoClass sc)(Code) | | Indicates if the naming manager is able to manage the identifier of a
persistent class.
Parameters:
sc - The speedo meta object representing the persistent class |
| canProvidePBinder | | boolean canProvidePBinder(Object hints, ClassLoader classLoader)(Code) | | indicates if the naming manager is able to build a PBinder instance for
this hints parameter specified
Parameters:
hints - is the helper of the PBinder building
Parameters:
classLoader - is the classloader to use for instanciate the PBinder |
| canProvidePNamingContext | | boolean canProvidePNamingContext(Object hints, ClassLoader classLoader)(Code) | | indicates if the naming manager is able to build a PNC instance for
this hints parameter specified
Parameters:
hints - is the helper of the PNC building
Parameters:
classLoader - is the classloader to use for instanciate the PNC |
| decode | | PName decode(PNameCoder pnc, Object oid, java.lang.Class clazz, JormFactory jf) throws PException(Code) | | Decodes an object identifier into a PName.
Parameters:
pnc - is the PNameCoder instance to use for the decoding the objectidentifier. The pnc parameter can be null. In this case the oid must
Parameters:
oid - is the object identifier
Parameters:
clazz - is the java.lang.Class of the persistent class identified bythe oid
Parameters:
jf - is the JormFactory instance. It permits to the object identifier decode as PName
throws:
PException - |
| defineClassIdentifierNameDef | | void defineClassIdentifierNameDef(NameDef nd, Class jc, SpeedoClass sc, ClassMapping cm, MIBuilderHelper mibh, JormMIMappingBuilder mb, Collection createdMOs) throws SpeedoException, PException(Code) | | Fill the name def of a class identifier
Parameters:
nd - is the name def to fill
Parameters:
sc - is the speedo meta object representing the class.
Parameters:
jc - is the jorm meta object representing the class.
Parameters:
cm - if the mapping structure hosting the mapping of the class.
Parameters:
mibh - is a helper for the management of the JORM meta info
Parameters:
mb - is the mapping builder permitting the creation of the mappingobjects.
Parameters:
createdMOs - is a result paramter. This collection must be fill withthe created Jorm Meta objects representing a class or a composite name.Here only the new composite names have to be added.
throws:
SpeedoException - if the speedo meta information is not completlydefined. |
| defineClassReferenceNameDef | | void defineClassReferenceNameDef(NameDef nd, ClassRef cr, SpeedoField sf, SpeedoClass currentClass, ClassMapping cm, MIBuilderHelper mibh, JormMIMappingBuilder mb) throws SpeedoException, PException(Code) | | Fill the name def of the class reference from a class
Parameters:
nd - is the name def to fill
Parameters:
cr - is the speedo meta object representing the class.
Parameters:
sf - is the speedo meta object representing the persistent reference to a class.
Parameters:
currentClass - is the class mapping the field
Parameters:
cm - if the mapping structure hosting the mapping of the class.
Parameters:
mibh - is a helper for the management of the JORM meta info
Parameters:
mb - is the mapping builder permitting the creation of the mappingobjects.
throws:
SpeedoException - if the speedo meta information is not completlydefined. |
| defineClassReferenceNameDef | | void defineClassReferenceNameDef(NameDef nd, ClassRef cr, SpeedoField sf, SpeedoClass currentClass, GenClassMapping gcm, MIBuilderHelper mibh, JormMIMappingBuilder mb) throws SpeedoException, PException(Code) | | Fill the name def of the class reference from a generic class
Parameters:
nd - is the name def to fill
Parameters:
cr - is the speedo meta object representing the class.
Parameters:
sf - is the speedo meta object representing the persistent reference to a class.
Parameters:
currentClass - is the class mapping the field
Parameters:
gcm - if the mapping structure hosting the mapping of the class.
Parameters:
mibh - is a helper for the management of the JORM meta info
Parameters:
mb - is the mapping builder permitting the creation of the mappingobjects.
Parameters:
createdMOs - is a result paramter. This collection must be fill withthe created Jorm Meta objects representing a class or a composite name.Here only the new composite names have to be added.
throws:
SpeedoException - if the speedo meta information is not completlydefined. |
| defineGenClassIdentifierNameDef | | void defineGenClassIdentifierNameDef(NameDef nd, GenClassRef gcr, SpeedoField sf, SpeedoClass currentClass, GenClassMapping gcm, MIBuilderHelper mibh, JormMIMappingBuilder mb) throws SpeedoException, PException(Code) | | Fill the name def of the gen class identifier
Parameters:
nd - is the name def to fill
Parameters:
gcr - is the JORM meta object representing the generic class reference.
Parameters:
sf - is the speedo meta object representing the persistent reference to a generic class.
Parameters:
currentClass - is the class mapping the field
Parameters:
gcm - if the mapping structure hosting the mapping of the generic class.
Parameters:
mibh - is a helper for the management of the JORM meta info
Parameters:
mb - is the mapping builder permitting the creation of the mappingobjects.
throws:
SpeedoException - if the speedo meta information is not completlydefined. |
| defineGenClassReferenceNameDef | | void defineGenClassReferenceNameDef(NameDef nd, GenClassRef gcr, SpeedoField sf, SpeedoClass currentClass, ClassMapping cm, MIBuilderHelper mibh, JormMIMappingBuilder mb) throws SpeedoException, PException(Code) | | Fill the name def of the generic class reference from a class
Parameters:
nd - is the name def to fill
Parameters:
gcr - is the speedo meta object representing the generic class.
Parameters:
sf - is the speedo meta object representing the persistent reference to a generic class.
Parameters:
currentClass - is the class mapping the field
Parameters:
cm - if the mapping structure hosting the mapping of the class.
Parameters:
mibh - is a helper for the management of the JORM meta info
Parameters:
mb - is the mapping builder permitting the creation of the mappingobjects.
throws:
SpeedoException - if the speedo meta information is not completlydefined. |
| encode | | Object encode(PName pn) throws PException(Code) | | Encode a PName into an object
Parameters:
pn - is the pname to encode |
| getGCPNameHints | | String getGCPNameHints(SpeedoClass sc, NameDef nd)(Code) | | compute a string value which permit to help the building of the genclass
PName (export)
Parameters:
sc - is the Speedo class which the hints must be specified
Parameters:
nd - is the name def of the gen class |
| getJormNamingConfig | | void getJormNamingConfig(NameDef nd, SpeedoClass targetClass, MetaObject sourceMO, String key, Properties result) throws SpeedoException(Code) | | computes the naming configuration information for a class or a reference.
This information is store as a String. The string value will be passed
to the getPBinder and getPNamingContext methods as hints. This method is
used at generation time.
| 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> |
Parameters:
targetClass - is the Speedo meta object representing the class whichis designates by the
Parameters:
result - is the Properties which must be filled |
| getNamingfields | | NamingField[] getNamingfields(SpeedoClass sc) throws PException(Code) | | Retrieves the array of field used in the identifier of a persistent class
and which values are not calculated by the application. The application
field must be set at makePersistent time.
Parameters:
sc - is the speedo meta object of the persistent class |
| getPBinder | | PBinder getPBinder(String className, String hints, ClassLoader classLoader, byte mappingStructureRule, Map cn2binder, Map cn2pnc) throws PException(Code) | | Build a PBinder instance for this hints parameter specified
Parameters:
hints - is the helper of the PBinder building. This hints must bethe result of the getJormConfig call.
Parameters:
classLoader - is the classloader to use for instanciate the PBinder
Parameters:
mappingStructureRule - indicates the rule to apply concerning thedata strucuture. Indeed a PBinder building can require to read the datasupport.
Parameters:
cn2binder - is the map of the existing PBinder instance(key = class name, value = PBinder instance)
Parameters:
cn2pnc - is the map of the existing PNC instance(key = class name, value = PNC instance) |
| getPNameHints | | String getPNameHints(SpeedoClass sc, NameDef nd)(Code) | | compute a string value which permit to help the building of the class
PName (export)
Parameters:
sc - is the Speedo class which the hints must be specified
Parameters:
nd - is the name def of the class |
| getPNamingContext | | PNamingContext getPNamingContext(String className, String hints, ClassLoader classLoader, byte mappingStructureRule, Map cn2binder, Map cn2pnc, Manager miManager, PClassMapping pcm) throws PException(Code) | | Build a PNamingContext instance for this hints parameter specified
Parameters:
hints - is the helper of the PBinder building. This hints must bethe result of the getJormConfig call.
Parameters:
classLoader - is the classloader to use for instanciate the PBinder
Parameters:
mappingStructureRule - indicates the rule to apply concerning thedata strucuture. Indeed a PBinder building can require to read the datasupport.
Parameters:
cn2binder - is the map of the existing PBinder instance(key = class name, value = PBinder instance)
Parameters:
cn2pnc - is the map of the existing PNC instance(key = class name, value = PNC instance) |
| setCache | | void setCache(CacheManager cache)(Code) | | |
| setLogger | | void setLogger(Logger logger)(Code) | | |
| setPMapper | | void setPMapper(PMapper mapper) throws PException(Code) | | |
| supportPNamingcontext | | boolean supportPNamingcontext()(Code) | | indicates if the use of PNamingContext is support by this mapping. If
true then getPNamingContext method can be use, otherwise the getPBinder
must be use instead. The case of PNamingContext are not supported, means
the PBinder are used as PNameCoder by PBinding as reference coder.
|
|
|