CTBIGDECIMAL
public static final int CTBIGDECIMAL
The coding type of the naming context is a bytearray
.
- 32768
CTBIGINTEGER
public static final int CTBIGINTEGER
The coding type of the naming context is a bytearray
.
- 16384
CTBYTE
public static final int CTBYTE
The coding type of the naming context is a byte
.
- 1
CTBYTEARRAY
public static final int CTBYTEARRAY
The coding type of the naming context is a bytearray
.
- 8192
CTCHAR
public static final int CTCHAR
The coding type of the naming context is an char
.
- 2
CTCHARARRAY
public static final int CTCHARARRAY
The coding type of the naming context is a chararray
.
- 4096
CTCOMPOSITE
public static final int CTCOMPOSITE
The coding type of the naming context is an Object
that
is composite name (e.g., a multi-fields relational primary key).
- 524288
CTDATE
public static final int CTDATE
The coding type of the naming context is a date
.
- 2048
CTINT
public static final int CTINT
The coding type of the naming context is an int
.
- 8
CTLONG
public static final int CTLONG
The coding type of the naming context is a long
.
- 16
CTOBYTE
public static final int CTOBYTE
The coding type of the naming context is a byte
.
- 32
CTOCHAR
public static final int CTOCHAR
The coding type of the naming context is an char
.
- 64
CTOINT
public static final int CTOINT
The coding type of the naming context is an int
.
- 256
CTOLONG
public static final int CTOLONG
The coding type of the naming context is a long
.
- 512
CTOSHORT
public static final int CTOSHORT
The coding type of the naming context is a short
.
- 128
CTSHORT
public static final int CTSHORT
The coding type of the naming context is a short
.
- 4
CTSTRING
public static final int CTSTRING
The coding type of the naming context is a string
.
- 1024
CTSYSTEM
public static final int CTSYSTEM
The coding type of the naming context is an Object
that
is DS-specific.
- 65536
codingSupported
public boolean codingSupported(int codingtype)
It tests if a given coding type is supported by this naming context.
codingtype
- One of the coding type defined by CTxxx constants
defined within this interface.
- It returns true if the coding type is supported by this naming
context.
decode
public PName decode(byte[] en)
throws PExceptionNaming
The decode methods recreates PName within a naming
context from an encoded representation. In the case of this method, the
encoded representation is an array of bytes. It must always be supported
by a naming context.
en
- The byte to be decoded.
- The resulting PName.
decodeAbstract
public PName decodeAbstract(Object en,
Object context)
throws PExceptionNaming,
UnsupportedOperationException
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).
en
- The Object to be decoded.context
- A context used to decode the related data.
- The resulting PName.
decodeBigDecimal
public PName decodeBigDecimal(BigDecimal en)
throws PExceptionNaming
The decodeBigDecimal methods recreates PName within a naming
context from an encoded representation. In the case of this method, the
encoded representation is a BigDecimal.
en
- The BigDecimal to be decoded.
- The resulting PName.
decodeBigInteger
public PName decodeBigInteger(BigInteger en)
throws PExceptionNaming
The decodeBigInteger methods recreates PName within a naming
context from an encoded representation. In the case of this method, the
encoded representation is a BigInteger.
en
- The BigInteger to be decoded.
- The resulting PName.
decodeByte
public PName decodeByte(byte en)
throws PExceptionNaming,
UnsupportedOperationException
The decodeByte methods recreates PName within a naming
context from an encoded representation. In the case of this method, the
encoded representation is a byte.
en
- The byte to be decoded.
- The resulting PName.
decodeChar
public PName decodeChar(char en)
throws PExceptionNaming,
UnsupportedOperationException
The decodeChar methods recreates PName within a naming
context from an encoded representation. In the case of this method, the
encoded representation is a char.
en
- The char to be decoded.
- The resulting PName.
decodeCharArray
public PName decodeCharArray(char[] en)
throws PExceptionNaming
The decodeCharArray methods recreates PName within a naming
context from an encoded representation. In the case of this method, the
encoded representation is a String.
en
- The char[] to be decoded.
- The resulting PName.
decodeDate
public PName decodeDate(Date en)
throws PExceptionNaming
The decodeDate methods recreates PName within a naming
context from an encoded representation. In the case of this method, the
encoded representation is a Date.
en
- The Date to be decoded.
- The resulting PName.
decodeInt
public PName decodeInt(int en)
throws PExceptionNaming,
UnsupportedOperationException
The decodeInt methods recreates PName within a naming
context from an encoded representation. In the case of this method, the
encoded representation is an int.
en
- The int to be decoded.
- The resulting PName.
decodeLong
public PName decodeLong(long en)
throws PExceptionNaming,
UnsupportedOperationException
The decodeLong methods recreates PName within a naming
context from an encoded representation. In the case of this method, the
encoded representation is a long.
en
- The long to be decoded.
- The resulting PName.
decodeObyte
public PName decodeObyte(Byte en)
throws PExceptionNaming,
UnsupportedOperationException
The decodeObyte methods recreates PName within a naming
context from an encoded representation. In the case of this method, the
encoded representation is a byte.
en
- The Byte to be decoded.
- The resulting PName.
decodeOchar
public PName decodeOchar(Character en)
throws PExceptionNaming,
UnsupportedOperationException
The decodeOchar methods recreates PName within a naming
context from an encoded representation. In the case of this method, the
encoded representation is a Character.
en
- The Character to be decoded.
- The resulting PName.
decodeOint
public PName decodeOint(Integer en)
throws PExceptionNaming,
UnsupportedOperationException
The decodeOint methods recreates PName within a naming
context from an encoded representation. In the case of this method, the
encoded representation is an Integer.
en
- The Integer to be decoded.
- The resulting PName.
decodeOlong
public PName decodeOlong(Long en)
throws PExceptionNaming,
UnsupportedOperationException
The decodeOlong methods recreates PName within a naming
context from an encoded representation. In the case of this method, the
encoded representation is a Long.
en
- The Long to be decoded.
- The resulting PName.
decodeOshort
public PName decodeOshort(Short en)
throws PExceptionNaming,
UnsupportedOperationException
The decodeOshort methods recreates PName within a naming
context from an encoded representation. In the case of this method, the
encoded representation is a Short.
en
- The Short to be decoded.
- The resulting PName.
decodeShort
public PName decodeShort(short en)
throws PExceptionNaming,
UnsupportedOperationException
The decodeShort methods recreates PName within a naming
context from an encoded representation. In the case of this method, the
encoded representation is a short.
en
- The short to be decoded.
- The resulting PName.
decodeString
public PName decodeString(String en)
throws PExceptionNaming
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.
en
- The String to be decoded.
- The resulting PName.
encode
public byte[] encode(PName pn)
throws PExceptionNaming
The encode method produces an encoded representation of a
PName within a naming context. The encoding format in the case of this
method is an array of bytes. It must be always supported by a naming
context.
pn
- The PName to be encoded
- The array of bytes corresponding to the encoded representation.
encodeAbstract
public Object encodeAbstract(PName pn)
throws PExceptionNaming,
UnsupportedOperationException
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).
pn
- The PName to be encoded.
- The Object corresponding to the encoded representation.
encodeBigDecimal
public BigDecimal encodeBigDecimal(PName pn)
throws PExceptionNaming
The encodeBigDecimal method produces an encoded representation of a
PName within a naming context. The encoding format in the case of this
method is a BigDecimal.
pn
- The PName to be encoded
- The BigDecimal corresponding to the encoded representation.
encodeBigInteger
public BigInteger encodeBigInteger(PName pn)
throws PExceptionNaming
The encodeBigInteger method produces an encoded representation of a
PName within a naming context. The encoding format in the case of this
method is a BigInteger.
pn
- The PName to be encoded
- The BigInteger corresponding to the encoded representation.
encodeByte
public byte encodeByte(PName pn)
throws PExceptionNaming,
UnsupportedOperationException
The encodeByte method produces an encoded representation of a
PName within a naming context. The encoding format in the case of this
method is a byte.
pn
- The PName to be encoded
- The byte corresponding to the encoded representation.
encodeChar
public char encodeChar(PName pn)
throws PExceptionNaming,
UnsupportedOperationException
The encodeChar method produces an encoded representation of a
PName within a naming context. The encoding format in the case of this
method is a char.
pn
- The PName to be encoded
- The char corresponding to the encoded representation.
encodeCharArray
public char[] encodeCharArray(PName pn)
throws PExceptionNaming
The encodeCharArray method produces an encoded representation of a
PName within a naming context. The encoding format in the case of this
method is a char[].
pn
- The PName to be encoded
- The char[] corresponding to the encoded representation.
encodeDate
public Date encodeDate(PName pn)
throws PExceptionNaming
The encodeDate method produces an encoded representation of a
PName within a naming context. The encoding format in the case of this
method is a Date.
pn
- The PName to be encoded
- The Date corresponding to the encoded representation.
encodeInt
public int encodeInt(PName pn)
throws PExceptionNaming,
UnsupportedOperationException
The encodeInt method produces an encoded representation of a
PName within a naming context. The encoding format in the case of this
method is a int.
pn
- The PName to be encoded
- The int corresponding to the encoded representation.
encodeLong
public long encodeLong(PName pn)
throws PExceptionNaming,
UnsupportedOperationException
The encodeLong method produces an encoded representation of a
PName within a naming context. The encoding format in the case of this
method is a long.
pn
- The PName to be encoded
- The long corresponding to the encoded representation.
encodeObyte
public Byte encodeObyte(PName pn)
throws PExceptionNaming,
UnsupportedOperationException
The encodeObyte method produces an encoded representation of a
PName within a naming context. The encoding format in the case of this
method is a Byte.
pn
- The PName to be encoded
- The Byte corresponding to the encoded representation.
encodeOchar
public Character encodeOchar(PName pn)
throws PExceptionNaming,
UnsupportedOperationException
The encodeOchar method produces an encoded representation of a
PName within a naming context. The encoding format in the case of this
method is a Character.
pn
- The PName to be encoded
- The Character corresponding to the encoded representation.
encodeOint
public Integer encodeOint(PName pn)
throws PExceptionNaming,
UnsupportedOperationException
The encodeOint method produces an encoded representation of a
PName within a naming context. The encoding format in the case of this
method is a Integer.
pn
- The PName to be encoded
- The Integer corresponding to the encoded representation.
encodeOlong
public Long encodeOlong(PName pn)
throws PExceptionNaming,
UnsupportedOperationException
The encodeOlong method produces an encoded representation of a
PName within a naming context. The encoding format in the case of this
method is a Long.
pn
- The PName to be encoded
- The Long corresponding to the encoded representation.
encodeOshort
public Short encodeOshort(PName pn)
throws PExceptionNaming,
UnsupportedOperationException
The encodeOshort method produces an encoded representation of a
PName within a naming context. The encoding format in the case of this
method is a Short.
pn
- The PName to be encoded
- The Short corresponding to the encoded representation.
encodeShort
public short encodeShort(PName pn)
throws PExceptionNaming,
UnsupportedOperationException
The encodeShort method produces an encoded representation of a
PName within a naming context. The encoding format in the case of this
method is a short.
pn
- The PName to be encoded
- The short corresponding to the encoded representation.
encodeString
public String encodeString(PName pn)
throws PExceptionNaming
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.
pn
- The PName to be encoded
- The String corresponding to the encoded representation.
getNull
public PName getNull()
It yields a "null" representation of a name within this naming context.
- The "null" PName associated with this naming context.
getPType
public PType getPType()
Retrieves the PType associated to the JORM class which is the type of
the name managed by this naming context.
- The related PType.
setNullPName
public void setNullPName(Object o)
throws PException
It assignes a object which defines a null representation of a name
within this naming context.
o
- can be a PNameGetter (generic or generated), a pname, or
a simple value (ex: Integer).
setPType
public void setPType(PType pt)
Assigns the PType associated to the JORM class which is the type of
the name managed by this naming context.
pt
- The PType of the JORM class reference managed by this naming
context.
supportCompositeField
public boolean supportCompositeField(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.
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.
- true if the proposed field is supported by this composite name.
supportDynamicComposite
public 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.
- true if dynamic getter is supported by composite name coding.
supportStaticComposite
public 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".
- true if static getter is supported by composite name coding.