org.objectweb.jorm.api

Interface PIndexedElem

public interface PIndexedElem

The PIndexedElem interface defines the representation of an element of a generic class. It provides a way to access the element value, as well as its index. It also allows the association of a status for such elements when the generic class accessor implemented by the MI supports delta modifications (@see PGenClassAccessor#deltaSupported).

Author:
R. Basset, P. Dechamboux

Field Summary

static byte
ELEM_CREATED
It specifies that this element is a new one within this generic class object.
static byte
ELEM_DELETED
It specifies that this element has been deleted from this generic class object.
static byte
ELEM_MODIFIED
It specifies that this element as been modified within this generic class object.
static byte
ELEM_UNMODIFIED
It specifies that this element existed at load time and that it has not been modified until then.

Method Summary

byte
getElemStatus()
It yields the status of this indexed element.
BigDecimal
pieGetBigDecimalElem()
It retrieves the value of a BigDecimal element.
BigInteger
pieGetBigIntegerElem()
It retrieves the value of a BigInteger element.
boolean
pieGetBooleanElem()
It retrieves the value of a boolean element.
byte[]
pieGetByteArrayElem()
It retrieves the value of a bytearray element.
byte
pieGetByteElem()
It retrieves the value of a byte element.
byte
pieGetByteIndexField(String fn)
It retrieves the value of a byte index field.
char[]
pieGetCharArrayElem()
It retrieves the value of a chararray element.
char
pieGetCharElem()
It retrieves the value of a char element.
char
pieGetCharIndexField(String fn)
It retrieves the value of a char index field.
Date
pieGetDateElem()
It retrieves the value of a date element.
Date
pieGetDateIndexField(String fn)
It retrieves the value of a date index field.
double
pieGetDoubleElem()
It retrieves the value of a double element.
float
pieGetFloatElem()
It retrieves the value of a float element.
int
pieGetIntElem()
It retrieves the value of an int element.
int
pieGetIntIndexField(String fn)
It retrieves the value of an int index field.
long
pieGetLongElem()
It retrieves the value of a long element.
long
pieGetLongIndexField(String fn)
It retrieves the value of a long index field.
Boolean
pieGetObooleanElem()
It retrieves the value of a boolean element.
Byte
pieGetObyteElem()
It retrieves the value of a byte element.
Byte
pieGetObyteIndexField(String fn)
It retrieves the value of a byte index field.
Character
pieGetOcharElem()
It retrieves the value of a char element.
Character
pieGetOcharIndexField(String fn)
It retrieves the value of a char index field.
Double
pieGetOdoubleElem()
It retrieves the value of a double element.
Float
pieGetOfloatElem()
It retrieves the value of a float element.
Integer
pieGetOintElem()
It retrieves the value of an int element.
Integer
pieGetOintIndexField(String fn)
It retrieves the value of an int index field.
Long
pieGetOlongElem()
It retrieves the value of a long element.
Long
pieGetOlongIndexField(String fn)
It retrieves the value of a long index field.
Short
pieGetOshortElem()
It retrieves the value of a short element.
Short
pieGetOshortIndexField(String fn)
It retrieves the value of a short index field.
PName
pieGetRefElem()
It retrieves the value of a reference element.
Serializable
pieGetSerializedElem()
It retrieves the value of a serialized element.
short
pieGetShortElem()
It retrieves the value of a short element.
short
pieGetShortIndexField(String fn)
It retrieves the value of a short index field.
String
pieGetStringElem()
It retrieves the value of a string element.
String
pieGetStringIndexField(String fn)
It retrieves the value of a string index field.
void
pieSetBigDecimalElem(BigDecimal value)
It assigns the value to a BigDecimal element.
void
pieSetBigIntegerElem(BigInteger value)
It assigns the value to a BigInteger element.
void
pieSetBooleanElem(boolean value)
It assigns the value to a boolean element.
void
pieSetByteArrayElem(byte[] value)
It assigns the value to a bytearray element.
void
pieSetByteElem(byte value)
It assigns the value to a byte element.
void
pieSetByteIndexField(String fn, byte value)
It assigns the value to a byte index field.
void
pieSetCharArrayElem(char[] value)
It assigns the value to a chararray element.
void
pieSetCharElem(char value)
It assigns the value to a char element.
void
pieSetCharIndexField(String fn, char value)
It assigns the value to a char index field.
void
pieSetDateElem(Date value)
It assigns the value to a date element.
void
pieSetDateIndexField(String fn, Date value)
It assigns the value to a date index field.
void
pieSetDoubleElem(double value)
It assigns the value to a double element.
void
pieSetFloatElem(float value)
It assigns the value to a float element.
void
pieSetIntElem(int value)
It assigns the value to an int element.
void
pieSetIntIndexField(String fn, int value)
It assigns the value to an int index field.
void
pieSetLongElem(long value)
It assigns the value to a long element.
void
pieSetLongIndexField(String fn, long value)
It assigns the value to a long index field.
void
pieSetObooleanElem(Boolean value)
It assigns the value to a boolean element.
void
pieSetObyteElem(Byte value)
It assigns the value to a Byte element.
void
pieSetObyteIndexField(String fn, Byte value)
It assigns the value to a Byte index field.
void
pieSetOcharElem(Character value)
It assigns the value to a Character element.
void
pieSetOcharIndexField(String fn, Character value)
It assigns the value to a Character index field.
void
pieSetOdoubleElem(Double value)
It assigns the value to a Double element.
void
pieSetOfloatElem(Float value)
It assigns the value to a Float element.
void
pieSetOintElem(Integer value)
It assigns the value to an Integer element.
void
pieSetOintIndexField(String fn, Integer value)
It assigns the value to an Integer index field.
void
pieSetOlongElem(Long value)
It assigns the value to a Long element.
void
pieSetOlongIndexField(String fn, Long value)
It assigns the value to a Long index field.
void
pieSetOshortElem(Short value)
It assigns the value to a Short element.
void
pieSetOshortIndexField(String fn, Short value)
It assigns the value to a Short index field.
void
pieSetRefElem(PName value)
It assigns the value to a reference element.
void
pieSetSerializedElem(Serializable value)
It assigns the value to a serialized element.
void
pieSetShortElem(short value)
It assigns the value to a short element.
void
pieSetShortIndexField(String fn, short value)
It assigns the value to a short index field.
void
pieSetStringElem(String value)
It assigns the value to a string element.
void
pieSetStringIndexField(String fn, String value)
It assigns the value to a string index field.

Field Details

ELEM_CREATED

public static final byte ELEM_CREATED
It specifies that this element is a new one within this generic class object. This means that is new index has been created.

Field Value:
1


ELEM_DELETED

public static final byte ELEM_DELETED
It specifies that this element has been deleted from this generic class object. This means that no more element with this index exists anymore wiothin this generic class object.

Field Value:
2


ELEM_MODIFIED

public static final byte ELEM_MODIFIED
It specifies that this element as been modified within this generic class object. This means that only the value of the indexed element has been modified, and especially not the index.

Field Value:
3


ELEM_UNMODIFIED

public static final byte ELEM_UNMODIFIED
It specifies that this element existed at load time and that it has not been modified until then. This means that neither the value of the indexed element nor its index has been modified.

Field Value:
4

Method Details

getElemStatus

public byte getElemStatus()
It yields the status of this indexed element. The status value belongs to the following ones:
  • ELEM_CREATED
  • ELEM_DELETED
  • ELEM_MODIFIED
  • ELEM_UNMODIFIED


pieGetBigDecimalElem

public BigDecimal pieGetBigDecimalElem()
            throws PException
It retrieves the value of a BigDecimal element.

Returns:
The java.math.BigDecimal value of the field as stored within the memory instance.


pieGetBigIntegerElem

public BigInteger pieGetBigIntegerElem()
            throws PException
It retrieves the value of a BigInteger element.

Returns:
The java.math.BigInteger value of the field as stored within the memory instance.


pieGetBooleanElem

public boolean pieGetBooleanElem()
            throws PException
It retrieves the value of a boolean element.

Returns:
The boolean value of the field as stored within the memory instance.


pieGetByteArrayElem

public byte[] pieGetByteArrayElem()
            throws PException
It retrieves the value of a bytearray element.

Returns:
The byte[] value of the field as stored within the memory instance.


pieGetByteElem

public byte pieGetByteElem()
            throws PException
It retrieves the value of a byte element.

Returns:
The byte value of the field as stored within the memory instance.


pieGetByteIndexField

public byte pieGetByteIndexField(String fn)
            throws PException
It retrieves the value of a byte index field.

Parameters:
fn - A String containing the name of the index field.

Returns:
The byte value of the field as stored within the memory instance.


pieGetCharArrayElem

public char[] pieGetCharArrayElem()
            throws PException
It retrieves the value of a chararray element.

Returns:
The char[] value of the field as stored within the memory instance.


pieGetCharElem

public char pieGetCharElem()
            throws PException
It retrieves the value of a char element.

Returns:
The char value of the field as stored within the memory instance.


pieGetCharIndexField

public char pieGetCharIndexField(String fn)
            throws PException
It retrieves the value of a char index field.

Parameters:
fn - A String containing the name of the index field.

Returns:
The char value of the field as stored within the memory instance.


pieGetDateElem

public Date pieGetDateElem()
            throws PException
It retrieves the value of a date element.

Returns:
The java.sql.Date value of the field as stored within the memory instance.


pieGetDateIndexField

public Date pieGetDateIndexField(String fn)
            throws PException
It retrieves the value of a date index field.

Parameters:
fn - A String containing the name of the index field.

Returns:
The java.util.Date value of the field as stored within the memory instance.


pieGetDoubleElem

public double pieGetDoubleElem()
            throws PException
It retrieves the value of a double element.

Returns:
The double value of the field as stored within the memory instance.


pieGetFloatElem

public float pieGetFloatElem()
            throws PException
It retrieves the value of a float element.

Returns:
The float value of the field as stored within the memory instance.


pieGetIntElem

public int pieGetIntElem()
            throws PException
It retrieves the value of an int element.

Returns:
The int value of the field as stored within the memory instance.


pieGetIntIndexField

public int pieGetIntIndexField(String fn)
            throws PException
It retrieves the value of an int index field.

Parameters:
fn - A String containing the name of the index field.

Returns:
The int value of the field as stored within the memory instance.


pieGetLongElem

public long pieGetLongElem()
            throws PException
It retrieves the value of a long element.

Returns:
The long value of the field as stored within the memory instance.


pieGetLongIndexField

public long pieGetLongIndexField(String fn)
            throws PException
It retrieves the value of a long index field.

Parameters:
fn - A String containing the name of the index field.

Returns:
The long value of the field as stored within the memory instance.


pieGetObooleanElem

public Boolean pieGetObooleanElem()
            throws PException
It retrieves the value of a boolean element.

Returns:
The Boolean value of the field as stored within the memory instance.


pieGetObyteElem

public Byte pieGetObyteElem()
            throws PException
It retrieves the value of a byte element.

Returns:
The Byte value of the field as stored within the memory instance.


pieGetObyteIndexField

public Byte pieGetObyteIndexField(String fn)
            throws PException
It retrieves the value of a byte index field.

Parameters:
fn - A String containing the name of the index field.

Returns:
The Byte value of the field as stored within the memory instance.


pieGetOcharElem

public Character pieGetOcharElem()
            throws PException
It retrieves the value of a char element.

Returns:
The Character value of the field as stored within the memory instance.


pieGetOcharIndexField

public Character pieGetOcharIndexField(String fn)
            throws PException
It retrieves the value of a char index field.

Parameters:
fn - A String containing the name of the index field.

Returns:
The Character value of the field as stored within the memory instance.


pieGetOdoubleElem

public Double pieGetOdoubleElem()
            throws PException
It retrieves the value of a double element.

Returns:
The Double value of the field as stored within the memory instance.


pieGetOfloatElem

public Float pieGetOfloatElem()
            throws PException
It retrieves the value of a float element.

Returns:
The Float value of the field as stored within the memory instance.


pieGetOintElem

public Integer pieGetOintElem()
            throws PException
It retrieves the value of an int element.

Returns:
The Integer value of the field as stored within the memory instance.


pieGetOintIndexField

public Integer pieGetOintIndexField(String fn)
            throws PException
It retrieves the value of an int index field.

Parameters:
fn - A String containing the name of the index field.

Returns:
The Integer value of the field as stored within the memory instance.


pieGetOlongElem

public Long pieGetOlongElem()
            throws PException
It retrieves the value of a long element.

Returns:
The Long value of the field as stored within the memory instance.


pieGetOlongIndexField

public Long pieGetOlongIndexField(String fn)
            throws PException
It retrieves the value of a long index field.

Parameters:
fn - A String containing the name of the index field.

Returns:
The Long value of the field as stored within the memory instance.


pieGetOshortElem

public Short pieGetOshortElem()
            throws PException
It retrieves the value of a short element.

Returns:
The Short value of the field as stored within the memory instance.


pieGetOshortIndexField

public Short pieGetOshortIndexField(String fn)
            throws PException
It retrieves the value of a short index field.

Parameters:
fn - A String containing the name of the index field.

Returns:
The Short value of the field as stored within the memory instance.


pieGetRefElem

public PName pieGetRefElem()
            throws PException
It retrieves the value of a reference element.

Returns:
The reference value of the field as stored within the memory instance.


pieGetSerializedElem

public Serializable pieGetSerializedElem()
            throws PException
It retrieves the value of a serialized element.

Returns:
The java.io.Serializable value of the field as stored within the memory instance.


pieGetShortElem

public short pieGetShortElem()
            throws PException
It retrieves the value of a short element.

Returns:
The short value of the field as stored within the memory instance.


pieGetShortIndexField

public short pieGetShortIndexField(String fn)
            throws PException
It retrieves the value of a short index field.

Parameters:
fn - A String containing the name of the index field.

Returns:
The short value of the field as stored within the memory instance.


pieGetStringElem

public String pieGetStringElem()
            throws PException
It retrieves the value of a string element.

Returns:
The java.lang.String value of the field as stored within the memory instance.


pieGetStringIndexField

public String pieGetStringIndexField(String fn)
            throws PException
It retrieves the value of a string index field.

Parameters:
fn - A String containing the name of the index field.

Returns:
The java.lang.String value of the field as stored within the memory instance.


pieSetBigDecimalElem

public void pieSetBigDecimalElem(BigDecimal value)
            throws PException
It assigns the value to a BigDecimal element.

Parameters:
value - The java.math.BigDecimal value to assign.


pieSetBigIntegerElem

public void pieSetBigIntegerElem(BigInteger value)
            throws PException
It assigns the value to a BigInteger element.

Parameters:
value - The java.math.BigInteger value to assign.


pieSetBooleanElem

public void pieSetBooleanElem(boolean value)
            throws PException
It assigns the value to a boolean element.

Parameters:
value - The boolean value to assign.


pieSetByteArrayElem

public void pieSetByteArrayElem(byte[] value)
            throws PException
It assigns the value to a bytearray element.

Parameters:
value - The byte[] value to assign.


pieSetByteElem

public void pieSetByteElem(byte value)
            throws PException
It assigns the value to a byte element.

Parameters:
value - The byte value to assign.


pieSetByteIndexField

public void pieSetByteIndexField(String fn,
                                 byte value)
            throws PException
It assigns the value to a byte index field.

Parameters:
fn - A String containing the name of the field to be set.
value - The byte value to assign.


pieSetCharArrayElem

public void pieSetCharArrayElem(char[] value)
            throws PException
It assigns the value to a chararray element.

Parameters:
value - The char[] value to assign.


pieSetCharElem

public void pieSetCharElem(char value)
            throws PException
It assigns the value to a char element.

Parameters:
value - The char value to assign.


pieSetCharIndexField

public void pieSetCharIndexField(String fn,
                                 char value)
            throws PException
It assigns the value to a char index field.

Parameters:
fn - A String containing the name of the field to be set.
value - The char value to assign.


pieSetDateElem

public void pieSetDateElem(Date value)
            throws PException
It assigns the value to a date element.

Parameters:
value - The java.sql.Date value to assign.


pieSetDateIndexField

public void pieSetDateIndexField(String fn,
                                 Date value)
            throws PException
It assigns the value to a date index field.

Parameters:
fn - A String containing the name of the field to be set.
value - The java.util.Date value to assign.


pieSetDoubleElem

public void pieSetDoubleElem(double value)
            throws PException
It assigns the value to a double element.

Parameters:
value - The double value to assign.


pieSetFloatElem

public void pieSetFloatElem(float value)
            throws PException
It assigns the value to a float element.

Parameters:
value - The float value to assign.


pieSetIntElem

public void pieSetIntElem(int value)
            throws PException
It assigns the value to an int element.

Parameters:
value - The int value to assign.


pieSetIntIndexField

public void pieSetIntIndexField(String fn,
                                int value)
            throws PException
It assigns the value to an int index field.

Parameters:
fn - A String containing the name of the field to be set.
value - The int value to assign.


pieSetLongElem

public void pieSetLongElem(long value)
            throws PException
It assigns the value to a long element.

Parameters:
value - The long value to assign.


pieSetLongIndexField

public void pieSetLongIndexField(String fn,
                                 long value)
            throws PException
It assigns the value to a long index field.

Parameters:
fn - A String containing the name of the field to be set.
value - The long value to assign.


pieSetObooleanElem

public void pieSetObooleanElem(Boolean value)
            throws PException
It assigns the value to a boolean element.

Parameters:
value - The Boolean value to assign.


pieSetObyteElem

public void pieSetObyteElem(Byte value)
            throws PException
It assigns the value to a Byte element.

Parameters:
value - The Byte value to assign.


pieSetObyteIndexField

public void pieSetObyteIndexField(String fn,
                                  Byte value)
            throws PException
It assigns the value to a Byte index field.

Parameters:
fn - A String containing the name of the field to be set.
value - The Byte value to assign.


pieSetOcharElem

public void pieSetOcharElem(Character value)
            throws PException
It assigns the value to a Character element.

Parameters:
value - The Character value to assign.


pieSetOcharIndexField

public void pieSetOcharIndexField(String fn,
                                  Character value)
            throws PException
It assigns the value to a Character index field.

Parameters:
fn - A String containing the name of the field to be set.
value - The Character value to assign.


pieSetOdoubleElem

public void pieSetOdoubleElem(Double value)
            throws PException
It assigns the value to a Double element.

Parameters:
value - The Double value to assign.


pieSetOfloatElem

public void pieSetOfloatElem(Float value)
            throws PException
It assigns the value to a Float element.

Parameters:
value - The Float value to assign.


pieSetOintElem

public void pieSetOintElem(Integer value)
            throws PException
It assigns the value to an Integer element.

Parameters:
value - The Integer value to assign.


pieSetOintIndexField

public void pieSetOintIndexField(String fn,
                                 Integer value)
            throws PException
It assigns the value to an Integer index field.

Parameters:
fn - A String containing the name of the field to be set.
value - The Integer value to assign.


pieSetOlongElem

public void pieSetOlongElem(Long value)
            throws PException
It assigns the value to a Long element.

Parameters:
value - The Long value to assign.


pieSetOlongIndexField

public void pieSetOlongIndexField(String fn,
                                  Long value)
            throws PException
It assigns the value to a Long index field.

Parameters:
fn - A String containing the name of the field to be set.
value - The Long value to assign.


pieSetOshortElem

public void pieSetOshortElem(Short value)
            throws PException
It assigns the value to a Short element.

Parameters:
value - The Short value to assign.


pieSetOshortIndexField

public void pieSetOshortIndexField(String fn,
                                   Short value)
            throws PException
It assigns the value to a Short index field.

Parameters:
fn - A String containing the name of the field to be set.
value - The Short value to assign.


pieSetRefElem

public void pieSetRefElem(PName value)
            throws PException
It assigns the value to a reference element.

Parameters:
value - The reference value to assign.


pieSetSerializedElem

public void pieSetSerializedElem(Serializable value)
            throws PException
It assigns the value to a serialized element.

Parameters:
value - The java.io.Serializable value to assign.


pieSetShortElem

public void pieSetShortElem(short value)
            throws PException
It assigns the value to a short element.

Parameters:
value - The short value to assign.


pieSetShortIndexField

public void pieSetShortIndexField(String fn,
                                  short value)
            throws PException
It assigns the value to a short index field.

Parameters:
fn - A String containing the name of the field to be set.
value - The short value to assign.


pieSetStringElem

public void pieSetStringElem(String value)
            throws PException
It assigns the value to a string element.

Parameters:
value - The java.lang.String value to assign.


pieSetStringIndexField

public void pieSetStringIndexField(String fn,
                                   String value)
            throws PException
It assigns the value to a string index field.

Parameters:
fn - A String containing the name of the field to be set.
value - The java.lang.String value to assign.