org.objectweb.jorm.facility.naming.polymorphid
Class PolymorphRefNC

java.lang.Object
  |
  +--org.objectweb.jorm.naming.lib.BasicPNamingContext
        |
        +--org.objectweb.jorm.facility.naming.polymorphid.PolymorphRefNC

All Implemented Interfaces:

PNameCoder, PNameManager, PNamingContext

public class PolymorphRefNC

extends BasicPNamingContext

implements PNamingContext

Author:

P. D?chamboux

Fields inherited from class org.objectweb.jorm.naming.lib.BasicPNamingContext

ptype

Fields inherited from interface org.objectweb.jorm.naming.api.PNameCoder

CTBYTE, CTBYTEARRAY, CTCHAR, CTCHARARRAY, CTCOMPOSITE, CTDATE, CTINT, CTLONG, CTOBYTE, CTOCHAR, CTOINT, CTOLONG, CTOSHORT, CTSHORT, CTSTRING, CTSYSTEM

Constructor Summary

PolymorphRefNC()

Method Summary

boolean	codingSupported(short codingtype) It tests if a given coding type is supported by this naming context.
PName	decodeAbstract(java.lang.Object en, java.lang.Object context) The decodeAbstract methods recreates PName within a naming context from an encoded representation.
PName	decodeString(java.lang.String en) The decodeString methods recreates PName within a naming context from an encoded representation.
java.lang.Object	encodeAbstract(PName pn) The encodeAbstract method produces an encoded representation of a PName within a naming context.
java.lang.String	encodeString(PName pn) The encodeString method produces an encoded representation of a PName within a naming context.
PName	export(java.lang.Object conn, java.lang.Object infoitem) It associates a PName to an information item within a naming context.
PName	export(java.lang.Object conn, java.lang.Object infoitem, java.lang.Object hints) It associates a PName to an information item within a naming context.
PName	getNull() It yields a "null" representation of a name within this naming context.
java.lang.Object	resolve(java.lang.Object conn, PName pn) It retrieves the information item associated to the given PName (if any exists).
void	setPType(PType pt) Assigns the PType associated to the JORM class which is the type of the name managed by this naming context.
boolean	supportCompositeField(java.lang.String fn, PType ft) In case of a naming context that supports composite names (i.e., names composed of several typed fields, whose type is limited to scalar ones), it tests if a particular field is defined by this composite name.
boolean	supportDynamicComposite() Tests if this naming context supports comosite name through a dynamic approach, which means that encodingAbstract/decodingAbstract use getter objects that implement the PNameGetter interface.
boolean	supportStaticComposite() Tests if this naming context supports comosite name through a static approach, which means that encodingAbstract/decodingAbstract use getter objects that implement specific NsFieldGetter interface generated for a particular field "Field" within a particular NameDef space "Ns".
void	unexport(java.lang.Object conn, PName pn) It removes the PName and all the associated information within a naming context (i.e., the association between the PName and its information item).

Methods inherited from class org.objectweb.jorm.naming.lib.BasicPNamingContext

decode, decodeByte, decodeChar, decodeDate, decodeInt, decodeLong, decodeObyte, decodeOchar, decodeOint, decodeOlong, decodeOshort, decodeShort, encode, encodeByte, encodeChar, encodeDate, encodeInt, encodeLong, encodeObyte, encodeOchar, encodeOint, encodeOlong, encodeOshort, encodeShort, getPType

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.naming.api.PNameManager

getPType

Methods inherited from interface org.objectweb.jorm.naming.api.PNameCoder

decode, decodeByte, decodeChar, decodeDate, decodeInt, decodeLong, decodeObyte, decodeOchar, decodeOint, decodeOlong, decodeOshort, decodeShort, encode, encodeByte, encodeChar, encodeDate, encodeInt, encodeLong, encodeObyte, encodeOchar, encodeOint, encodeOlong, encodeOshort, encodeShort

Constructor Detail

PolymorphRefNC

public PolymorphRefNC()

Method Detail

codingSupported

public boolean codingSupported(short codingtype)

Description copied from interface: PNameCoder

It tests if a given coding type is supported by this naming context.

Specified by:

codingSupported in interface PNameCoder

Overrides:

codingSupported in class BasicPNamingContext

Following copied from interface: org.objectweb.jorm.naming.api.PNameCoder

Parameters:

codingtype - One of the coding type defined by CTxxx constants defined within this interface.

Returns:

It returns true if the coding type is supported by this naming context.

decodeAbstract

public PName decodeAbstract(java.lang.Object en,
                            java.lang.Object context)
                     throws PExceptionNaming,
                            java.lang.UnsupportedOperationException

Description copied from interface: PNameCoder

The decodeAbstract methods recreates PName within a naming context from an encoded representation. In the case of this method, the encoded representation is abstract, which means that this is a Java object of any complexity. One example of such object is a getter interface representing a relational primary key (also called composite names).

Specified by:

decodeAbstract in interface PNameCoder

Overrides:

decodeAbstract in class BasicPNamingContext

Following copied from interface: org.objectweb.jorm.naming.api.PNameCoder

Parameters:

context - A context used to decode the related data.

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

en - The Object to be decoded.

Returns:

The resulting PName.

decodeString

public PName decodeString(java.lang.String en)
                   throws PExceptionNaming

Description copied from interface: PNameCoder

The decodeString methods recreates PName within a naming context from an encoded representation. In the case of this method, the encoded representation is a String.

Specified by:

decodeString in interface PNameCoder

Following copied from interface: org.objectweb.jorm.naming.api.PNameCoder

Parameters:

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

en - The String to be decoded.

Returns:

The resulting PName.

encodeAbstract

public java.lang.Object encodeAbstract(PName pn)
                                throws PExceptionNaming,
                                       java.lang.UnsupportedOperationException

Description copied from interface: PNameCoder

The encodeAbstract method produces an encoded representation of a PName within a naming context. The encoding format is the case of this method is a Java object of any complexity. Example of such object is a getter interface giving access of the fields of a relational primary key (also called composite names).

Specified by:

encodeAbstract in interface PNameCoder

Overrides:

encodeAbstract in class BasicPNamingContext

Following copied from interface: org.objectweb.jorm.naming.api.PNameCoder

Parameters:

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

pn - The PName to be encoded.

Returns:

The Object corresponding to the encoded representation.

encodeString

public java.lang.String encodeString(PName pn)
                              throws PExceptionNaming

Description copied from interface: PNameCoder

The encodeString method produces an encoded representation of a PName within a naming context. The encoding format in the case of this method is a String.

Specified by:

encodeString in interface PNameCoder

Following copied from interface: org.objectweb.jorm.naming.api.PNameCoder

Parameters:

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

pn - The PName to be encoded

Returns:

The String corresponding to the encoded representation.

export

public PName export(java.lang.Object conn,
                    java.lang.Object infoitem)
             throws PException

Description copied from interface: PNameManager

It associates a PName to an information item within a naming context.

Specified by:

export in interface PNameManager

Following copied from interface: org.objectweb.jorm.naming.api.PNameManager

Parameters:

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

infoitem - The information item that must be accessible through a PName within a naming context.

Returns:

The PName associated to the given information item.

Throws:

PExceptionNaming - Raised in case of problem within the naming context.

PExceptionIO - Raised in case of problem during the access of the data store.

export

public PName export(java.lang.Object conn,
                    java.lang.Object infoitem,
                    java.lang.Object hints)
             throws PException

Description copied from interface: PNameManager

It associates a PName to an information item within a naming context.

Specified by:

export in interface PNameManager

Following copied from interface: org.objectweb.jorm.naming.api.PNameManager

Parameters:

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

infoitem - The information item that must be accessible through a PName within a naming context.

hints - Any information relevant for name creation.

Returns:

The PName associated to the given information item.

Throws:

PExceptionNaming - Raised in case of problem within the naming context.

PExceptionIO - Raised in case of problem during the access of the data store.

getNull

public PName getNull()

Description copied from interface: PNameCoder

It yields a "null" representation of a name within this naming context.

Specified by:

getNull in interface PNameCoder

Following copied from interface: org.objectweb.jorm.naming.api.PNameCoder

Returns:

The "null" PName associated with this naming context.

setPType

public void setPType(PType pt)

Description copied from interface: PNameManager

Assigns the PType associated to the JORM class which is the type of the name managed by this naming context.

Specified by:

setPType in interface PNameManager

Overrides:

setPType in class BasicPNamingContext

Following copied from interface: org.objectweb.jorm.naming.api.PNameManager

Parameters:

pt - The PType of the JORM class reference managed by this naming context.

resolve

public java.lang.Object resolve(java.lang.Object conn,
                                PName pn)
                         throws PException

Description copied from interface: PNamingContext

It retrieves the information item associated to the given PName (if any exists).

Specified by:

resolve in interface PNamingContext

Following copied from interface: org.objectweb.jorm.naming.api.PNamingContext

Parameters:

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

pn - The PName to be looked up.

Returns:

The information item associated with the given PName within a naming context.

Throws:

PExceptionNaming - Raised in case of problem within the naming context.

PExceptionIO - Raised in case of problem during the access of the data store

supportDynamicComposite

public boolean supportDynamicComposite()

Description copied from interface: PNameCoder

Tests if this naming context supports comosite name through a dynamic approach, which means that encodingAbstract/decodingAbstract use getter objects that implement the PNameGetter interface.

Specified by:

supportDynamicComposite in interface PNameCoder

Overrides:

supportDynamicComposite in class BasicPNamingContext

Following copied from interface: org.objectweb.jorm.naming.api.PNameCoder

Returns:

true if dynamic getter is supported by composite name coding.

supportCompositeField

public boolean supportCompositeField(java.lang.String fn,
                                     PType ft)

Description copied from interface: PNameCoder

In case of a naming context that supports composite names (i.e., names composed of several typed fields, whose type is limited to scalar ones), it tests if a particular field is defined by this composite name. It should be used by PClassMapping objects in order to verify, at deployment time, that naming contexts that are defined to manage the various references supports the same encoding name structure.

Specified by:

supportCompositeField in interface PNameCoder

Overrides:

supportCompositeField in class BasicPNamingContext

Following copied from interface: org.objectweb.jorm.naming.api.PNameCoder

Returns:

true if the proposed field is supported by this composite name.

supportStaticComposite

public boolean supportStaticComposite()

Description copied from interface: PNameCoder

Tests if this naming context supports comosite name through a static approach, which means that encodingAbstract/decodingAbstract use getter objects that implement specific NsFieldGetter interface generated for a particular field "Field" within a particular NameDef space "Ns".

Specified by:

supportStaticComposite in interface PNameCoder

Overrides:

supportStaticComposite in class BasicPNamingContext

Following copied from interface: org.objectweb.jorm.naming.api.PNameCoder

Returns:

true if static getter is supported by composite name coding.

unexport

public void unexport(java.lang.Object conn,
                     PName pn)
              throws PException

Description copied from interface: PNameManager

It removes the PName and all the associated information within a naming context (i.e., the association between the PName and its information item).

Specified by:

unexport in interface PNameManager

Following copied from interface: org.objectweb.jorm.naming.api.PNameManager

Parameters:

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

pn - A PName valid in this naming context. In case of a PBinder, export is done on a PBinding.

Throws:

PExceptionNaming - Raised in case of problem within the naming context.

PExceptionIO - Raised in case of problem during the access of the data store