|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
The PNameCoder defines the external structure of the name it manages, which corresponds to the type involved in the encoding/decoding process. Furthermore, several name format may be supported by a particular name coder.
| Field Summary | |
static short |
CTBYTE
The coding type of the naming context is a byte. |
static short |
CTBYTEARRAY
The coding type of the naming context is a bytearray. |
static short |
CTCHAR
The coding type of the naming context is an char. |
static short |
CTCHARARRAY
The coding type of the naming context is a chararray. |
static short |
CTCOMPOSITE
The coding type of the naming context is an Object that
is composite name (e.g., a multi-fields relational primary key). |
static short |
CTDATE
The coding type of the naming context is a date. |
static short |
CTINT
The coding type of the naming context is an int. |
static short |
CTLONG
The coding type of the naming context is a long. |
static short |
CTOBYTE
The coding type of the naming context is a byte. |
static short |
CTOCHAR
The coding type of the naming context is an char. |
static short |
CTOINT
The coding type of the naming context is an int. |
static short |
CTOLONG
The coding type of the naming context is a long. |
static short |
CTOSHORT
The coding type of the naming context is a short. |
static short |
CTSHORT
The coding type of the naming context is a short. |
static short |
CTSTRING
The coding type of the naming context is a string. |
static short |
CTSYSTEM
The coding type of the naming context is an Object that
is DS-specific. |
| Method Summary | |
boolean |
codingSupported(short codingtype)
It tests if a given coding type is supported by this naming context. |
PName |
decode(byte[] en)
The decode methods recreates PName within a naming context from an encoded representation. |
PName |
decodeAbstract(java.lang.Object en,
java.lang.Object context)
The decodeAbstract methods recreates PName within a naming context from an encoded representation. |
PName |
decodeByte(byte en)
The decodeByte methods recreates PName within a naming context from an encoded representation. |
PName |
decodeChar(char en)
The decodeChar methods recreates PName within a naming context from an encoded representation. |
PName |
decodeCharArray(char[] en)
The decodeCharArray methods recreates PName within a naming context from an encoded representation. |
PName |
decodeDate(java.util.Date en)
The decodeDate methods recreates PName within a naming context from an encoded representation. |
PName |
decodeInt(int en)
The decodeInt methods recreates PName within a naming context from an encoded representation. |
PName |
decodeLong(long en)
The decodeLong methods recreates PName within a naming context from an encoded representation. |
PName |
decodeObyte(java.lang.Byte en)
The decodeObyte methods recreates PName within a naming context from an encoded representation. |
PName |
decodeOchar(java.lang.Character en)
The decodeOchar methods recreates PName within a naming context from an encoded representation. |
PName |
decodeOint(java.lang.Integer en)
The decodeOint methods recreates PName within a naming context from an encoded representation. |
PName |
decodeOlong(java.lang.Long en)
The decodeOlong methods recreates PName within a naming context from an encoded representation. |
PName |
decodeOshort(java.lang.Short en)
The decodeOshort methods recreates PName within a naming context from an encoded representation. |
PName |
decodeShort(short en)
The decodeShort 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. |
byte[] |
encode(PName pn)
The encode method produces an encoded representation of a PName within a naming context. |
java.lang.Object |
encodeAbstract(PName pn)
The encodeAbstract method produces an encoded representation of a PName within a naming context. |
byte |
encodeByte(PName pn)
The encodeByte method produces an encoded representation of a PName within a naming context. |
char |
encodeChar(PName pn)
The encodeChar method produces an encoded representation of a PName within a naming context. |
char[] |
encodeCharArray(PName pn)
The encodeCharArray method produces an encoded representation of a PName within a naming context. |
java.util.Date |
encodeDate(PName pn)
The encodeDate method produces an encoded representation of a PName within a naming context. |
int |
encodeInt(PName pn)
The encodeInt method produces an encoded representation of a PName within a naming context. |
long |
encodeLong(PName pn)
The encodeLong method produces an encoded representation of a PName within a naming context. |
java.lang.Byte |
encodeObyte(PName pn)
The encodeObyte method produces an encoded representation of a PName within a naming context. |
java.lang.Character |
encodeOchar(PName pn)
The encodeOchar method produces an encoded representation of a PName within a naming context. |
java.lang.Integer |
encodeOint(PName pn)
The encodeOint method produces an encoded representation of a PName within a naming context. |
java.lang.Long |
encodeOlong(PName pn)
The encodeOlong method produces an encoded representation of a PName within a naming context. |
java.lang.Short |
encodeOshort(PName pn)
The encodeOshort method produces an encoded representation of a PName within a naming context. |
short |
encodeShort(PName pn)
The encodeShort 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 |
getNull()
It yields a "null" representation of a name within this naming context. |
PType |
getPType()
Retrieves the PType associated to the JORM class which is the type of the name managed by this naming context. |
void |
setNullPName(java.lang.Object o)
It assignes a object which defines a null representation of a name within this naming context. |
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". |
| Field Detail |
public static final short CTBYTE
byte.
public static final short CTCHAR
char.
public static final short CTSHORT
short.
public static final short CTINT
int.
public static final short CTLONG
long.
public static final short CTOBYTE
byte.
public static final short CTOCHAR
char.
public static final short CTOSHORT
short.
public static final short CTOINT
int.
public static final short CTOLONG
long.
public static final short CTSTRING
string.
public static final short CTDATE
date.
public static final short CTCHARARRAY
chararray.
public static final short CTBYTEARRAY
bytearray.
public static final short CTSYSTEM
Object that
is DS-specific.
public static final short CTCOMPOSITE
Object that
is composite name (e.g., a multi-fields relational primary key).
| Method Detail |
public boolean codingSupported(short codingtype)
codingtype - One of the coding type defined by CTxxx constants
defined within this interface.
public PName decode(byte[] en)
throws PExceptionNaming
en - The byte to be decoded.
PExceptionNaming
public PName decodeAbstract(java.lang.Object en,
java.lang.Object context)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
context - A context used to decode the related data.en - The Object to be decoded.
PExceptionNaming
java.lang.UnsupportedOperationException
public PName decodeByte(byte en)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
en - The byte to be decoded.
PExceptionNaming
java.lang.UnsupportedOperationException
public PName decodeObyte(java.lang.Byte en)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
en - The Byte to be decoded.
PExceptionNaming
java.lang.UnsupportedOperationException
public PName decodeChar(char en)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
en - The char to be decoded.
PExceptionNaming
java.lang.UnsupportedOperationException
public PName decodeOchar(java.lang.Character en)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
en - The Character to be decoded.
PExceptionNaming
java.lang.UnsupportedOperationException
public PName decodeInt(int en)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
en - The int to be decoded.
PExceptionNaming
java.lang.UnsupportedOperationException
public PName decodeOint(java.lang.Integer en)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
en - The Integer to be decoded.
PExceptionNaming
java.lang.UnsupportedOperationException
public PName decodeLong(long en)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
en - The long to be decoded.
PExceptionNaming
java.lang.UnsupportedOperationException
public PName decodeOlong(java.lang.Long en)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
en - The Long to be decoded.
PExceptionNaming
java.lang.UnsupportedOperationException
public PName decodeShort(short en)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
en - The short to be decoded.
PExceptionNaming
java.lang.UnsupportedOperationException
public PName decodeOshort(java.lang.Short en)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
en - The Short to be decoded.
PExceptionNaming
java.lang.UnsupportedOperationException
public PName decodeString(java.lang.String en)
throws PExceptionNaming
en - The String to be decoded.
PExceptionNaming
public PName decodeCharArray(char[] en)
throws PExceptionNaming
en - The char[] to be decoded.
PExceptionNaming
public PName decodeDate(java.util.Date en)
throws PExceptionNaming
en - The Date to be decoded.
PExceptionNaming
public byte[] encode(PName pn)
throws PExceptionNaming
pn - The PName to be encoded
PExceptionNaming
public java.lang.Object encodeAbstract(PName pn)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
pn - The PName to be encoded.
PExceptionNaming
java.lang.UnsupportedOperationException
public byte encodeByte(PName pn)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
pn - The PName to be encoded
PExceptionNaming
java.lang.UnsupportedOperationException
public java.lang.Byte encodeObyte(PName pn)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
pn - The PName to be encoded
PExceptionNaming
java.lang.UnsupportedOperationException
public char encodeChar(PName pn)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
pn - The PName to be encoded
PExceptionNaming
java.lang.UnsupportedOperationException
public java.lang.Character encodeOchar(PName pn)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
pn - The PName to be encoded
PExceptionNaming
java.lang.UnsupportedOperationException
public int encodeInt(PName pn)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
pn - The PName to be encoded
PExceptionNaming
java.lang.UnsupportedOperationException
public java.lang.Integer encodeOint(PName pn)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
pn - The PName to be encoded
PExceptionNaming
java.lang.UnsupportedOperationException
public long encodeLong(PName pn)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
pn - The PName to be encoded
PExceptionNaming
java.lang.UnsupportedOperationException
public java.lang.Long encodeOlong(PName pn)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
pn - The PName to be encoded
PExceptionNaming
java.lang.UnsupportedOperationException
public short encodeShort(PName pn)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
pn - The PName to be encoded
PExceptionNaming
java.lang.UnsupportedOperationException
public java.lang.Short encodeOshort(PName pn)
throws PExceptionNaming,
java.lang.UnsupportedOperationException
pn - The PName to be encoded
PExceptionNaming
java.lang.UnsupportedOperationException
public java.lang.String encodeString(PName pn)
throws PExceptionNaming
pn - The PName to be encoded
PExceptionNaming
public char[] encodeCharArray(PName pn)
throws PExceptionNaming
pn - The PName to be encoded
PExceptionNaming
public java.util.Date encodeDate(PName pn)
throws PExceptionNaming
pn - The PName to be encoded
PExceptionNamingpublic PName getNull()
public void setNullPName(java.lang.Object o)
throws PException
o - can be a PNameGetter (generic or generated), a pname, or
a simple value (ex: Integer).
PExceptionpublic boolean supportDynamicComposite()
public boolean supportCompositeField(java.lang.String fn,
PType ft)
public boolean supportStaticComposite()
public PType getPType()
public void setPType(PType pt)
pt - The PType of the JORM class reference managed by this naming
context.
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||