Jorm Developer Documentation: Interface PAccessorGen

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.objectweb.jorm.api
Interface PAccessorGen

All Superinterfaces:: PAccessor

public interface PAccessorGen
extends PAccessor

The PAccessorGen interface defines a generic accessor to be used by persistent bindings to access persistent variable within memory instances. This interface is implemented for each JORM class in order to define specific accessors associated to such a memory instance.

Author:: R. Basset, P. D?chamboux

Method Summary

java.math.BigDecimal paGetBigDecimalField(java.lang.String fn)
          It retrieves the value of a BigDecimal field.

boolean paGetBooleanField(java.lang.String fn)
          It retrieves the value of a boolean field.

byte paGetByteField(java.lang.String fn)
          It retrieves the value of a byte field.

char paGetCharField(java.lang.String fn)
          It retrieves the value of a char field.

java.util.Date paGetDateField(java.lang.String fn)
          It retrieves the value of a date field.

double paGetDoubleField(java.lang.String fn)
          It retrieves the value of a double field.

float paGetFloatField(java.lang.String fn)
          It retrieves the value of a float field.

int paGetIntField(java.lang.String fn)
          It retrieves the value of an int field.

long paGetLongField(java.lang.String fn)
          It retrieves the value of a long field.

java.lang.Boolean paGetObooleanField(java.lang.String fn)
          It retrieves the value of a Boolean field.

java.lang.Byte paGetObyteField(java.lang.String fn)
          It retrieves the value of a Byte field.

java.lang.Character paGetOcharField(java.lang.String fn)
          It retrieves the value of a Character field.

java.lang.Double paGetOdoubleField(java.lang.String fn)
          It retrieves the value of a Double field.

java.lang.Float paGetOfloatField(java.lang.String fn)
          It retrieves the value of a Float field.

java.lang.Integer paGetOintField(java.lang.String fn)
          It retrieves the value of an Integer field.

java.lang.Long paGetOlongField(java.lang.String fn)
          It retrieves the value of a Long field.

java.lang.Short paGetOshortField(java.lang.String fn)
          It retrieves the value of a Short field.

java.lang.Object paGetRefField(java.lang.String fn, java.lang.Object connection)
          It retrieves the value of a reference field.

java.io.Serializable paGetSerializedField(java.lang.String fn)
          It retrieves the value of a serialized field.

short paGetShortField(java.lang.String fn)
          It retrieves the value of a short field.

java.lang.String paGetStringField(java.lang.String fn)
          It retrieves the value of a string field.

void paSetBigDecimalField(java.lang.String fn, java.math.BigDecimal value)
          It assigns the value to a BigDecimal field.

void paSetBooleanField(java.lang.String fn, boolean value)
          It assigns the value to a boolean field.

void paSetByteField(java.lang.String fn, byte value)
          It assigns the value to a byte field.

void paSetCharField(java.lang.String fn, char value)
          It assigns the value to a char field.

void paSetDateField(java.lang.String fn, java.util.Date value)
          It assigns the value to a date field.

void paSetDoubleField(java.lang.String fn, double value)
          It assigns the value to a double field.

void paSetFloatField(java.lang.String fn, float value)
          It assigns the value to a float field.

void paSetIntField(java.lang.String fn, int value)
          It assigns the value to an int field.

void paSetLongField(java.lang.String fn, long value)
          It assigns the value to a long field.

void paSetObooleanField(java.lang.String fn, java.lang.Boolean value)
          It assigns the value to a Boolean field.

void paSetObyteField(java.lang.String fn, java.lang.Byte value)
          It assigns the value to a Byte field.

void paSetOcharField(java.lang.String fn, java.lang.Character value)
          It assigns the value to a Character field.

void paSetOdoubleField(java.lang.String fn, java.lang.Double value)
          It assigns the value to a Double field.

void paSetOfloatField(java.lang.String fn, java.lang.Float value)
          It assigns the value to a Float field.

void paSetOintField(java.lang.String fn, java.lang.Integer value)
          It assigns the value to an Integer field.

void paSetOlongField(java.lang.String fn, java.lang.Long value)
          It assigns the value to a Long field.

void paSetOshortField(java.lang.String fn, java.lang.Short value)
          It assigns the value to a Short field.

void paSetRefField(java.lang.String fn, java.lang.Object value, java.lang.Object connection)
          It assigns the value to a reference field.

void paSetSerializedField(java.lang.String fn, java.io.Serializable value)
          It assigns the value to a serialized field.

void paSetShortField(java.lang.String fn, short value)
          It assigns the value to a short field.

void paSetStringField(java.lang.String fn, java.lang.String value)
          It assigns the value to a string field.

Methods inherited from interface org.objectweb.jorm.api.PAccessor

getMemoryInstance

Method Detail

paGetBooleanField

public boolean paGetBooleanField(java.lang.String fn)
                          throws PException

It retrieves the value of a boolean field.

Parameters:: fn - A String containing the name of the field.
Returns:: The boolean value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetObooleanField

public java.lang.Boolean paGetObooleanField(java.lang.String fn)
                                     throws PException

It retrieves the value of a Boolean field.

Parameters:: fn - A String containing the name of the field.
Returns:: The Boolean value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetByteField

public byte paGetByteField(java.lang.String fn)
                    throws PException

It retrieves the value of a byte field.

Parameters:: fn - A String containing the name of the field.
Returns:: The byte value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetObyteField

public java.lang.Byte paGetObyteField(java.lang.String fn)
                               throws PException

It retrieves the value of a Byte field.

Parameters:: fn - A String containing the name of the field.
Returns:: The Byte value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetCharField

public char paGetCharField(java.lang.String fn)
                    throws PException

It retrieves the value of a char field.

Parameters:: fn - A String containing the name of the field.
Returns:: The char value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetOcharField

public java.lang.Character paGetOcharField(java.lang.String fn)
                                    throws PException

It retrieves the value of a Character field.

Parameters:: fn - A String containing the name of the field.
Returns:: The Character value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetShortField

public short paGetShortField(java.lang.String fn)
                      throws PException

It retrieves the value of a short field.

Parameters:: fn - A String containing the name of the field.
Returns:: The short value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetOshortField

public java.lang.Short paGetOshortField(java.lang.String fn)
                                 throws PException

It retrieves the value of a Short field.

Parameters:: fn - A String containing the name of the field.
Returns:: The Short value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetIntField

public int paGetIntField(java.lang.String fn)
                  throws PException

It retrieves the value of an int field.

Parameters:: fn - A String containing the name of the field.
Returns:: The int value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetOintField

public java.lang.Integer paGetOintField(java.lang.String fn)
                                 throws PException

It retrieves the value of an Integer field.

Parameters:: fn - A String containing the name of the field.
Returns:: The Integer value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetLongField

public long paGetLongField(java.lang.String fn)
                    throws PException

It retrieves the value of a long field.

Parameters:: fn - A String containing the name of the field.
Returns:: The long value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetOlongField

public java.lang.Long paGetOlongField(java.lang.String fn)
                               throws PException

It retrieves the value of a Long field.

Parameters:: fn - A String containing the name of the field.
Returns:: The Long value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetFloatField

public float paGetFloatField(java.lang.String fn)
                      throws PException

It retrieves the value of a float field.

Parameters:: fn - A String containing the name of the field.
Returns:: The float value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetOfloatField

public java.lang.Float paGetOfloatField(java.lang.String fn)
                                 throws PException

It retrieves the value of a Float field.

Parameters:: fn - A String containing the name of the field.
Returns:: The Float value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetDoubleField

public double paGetDoubleField(java.lang.String fn)
                        throws PException

It retrieves the value of a double field.

Parameters:: fn - A String containing the name of the field.
Returns:: The double value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetOdoubleField

public java.lang.Double paGetOdoubleField(java.lang.String fn)
                                   throws PException

It retrieves the value of a Double field.

Parameters:: fn - A String containing the name of the field.
Returns:: The Double value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetStringField

public java.lang.String paGetStringField(java.lang.String fn)
                                  throws PException

It retrieves the value of a string field.

Parameters:: fn - A String containing the name of the field.
Returns:: The java.lang.String value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetDateField

public java.util.Date paGetDateField(java.lang.String fn)
                              throws PException

It retrieves the value of a date field.

Parameters:: fn - A String containing the name of the field.
Returns:: The java.sql.Date value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetSerializedField

public java.io.Serializable paGetSerializedField(java.lang.String fn)
                                          throws PException

It retrieves the value of a serialized field.

Parameters:: fn - A String containing the name of the field.
Returns:: The java.io.Serializable value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetBigDecimalField

public java.math.BigDecimal paGetBigDecimalField(java.lang.String fn)
                                          throws PException

It retrieves the value of a BigDecimal field.

Parameters:: fn - A String containing the name of the field.
Returns:: The java.math.BigDecimal value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paGetRefField

public java.lang.Object paGetRefField(java.lang.String fn,
                                      java.lang.Object connection)
                               throws PException

It retrieves the value of a reference field.

Parameters:: fn - A String containing the name of the field.; connection - The connection to access to support. This connection can be used to resolve a pname for example.
Returns:: The reference value of the field as stored within the memory instance.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetBooleanField

public void paSetBooleanField(java.lang.String fn,
                              boolean value)
                       throws PException

It assigns the value to a boolean field.

Parameters:: fn - A String containing the name of the field to be set.; value - The boolean value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetObooleanField

public void paSetObooleanField(java.lang.String fn,
                               java.lang.Boolean value)
                        throws PException

It assigns the value to a Boolean field.

Parameters:: fn - A String containing the name of the field to be set.; value - The Boolean value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetByteField

public void paSetByteField(java.lang.String fn,
                           byte value)
                    throws PException

It assigns the value to a byte field.

Parameters:: fn - A String containing the name of the field to be set.; value - The byte value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetObyteField

public void paSetObyteField(java.lang.String fn,
                            java.lang.Byte value)
                     throws PException

It assigns the value to a Byte field.

Parameters:: fn - A String containing the name of the field to be set.; value - The Byte value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetCharField

public void paSetCharField(java.lang.String fn,
                           char value)
                    throws PException

It assigns the value to a char field.

Parameters:: fn - A String containing the name of the field to be set.; value - The char value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetOcharField

public void paSetOcharField(java.lang.String fn,
                            java.lang.Character value)
                     throws PException

It assigns the value to a Character field.

Parameters:: fn - A String containing the name of the field to be set.; value - The Character value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetShortField

public void paSetShortField(java.lang.String fn,
                            short value)
                     throws PException

It assigns the value to a short field.

Parameters:: fn - A String containing the name of the field to be set.; value - The short value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetOshortField

public void paSetOshortField(java.lang.String fn,
                             java.lang.Short value)
                      throws PException

It assigns the value to a Short field.

Parameters:: fn - A String containing the name of the field to be set.; value - The Short value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetIntField

public void paSetIntField(java.lang.String fn,
                          int value)
                   throws PException

It assigns the value to an int field.

Parameters:: fn - A String containing the name of the field to be set.; value - The int value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetOintField

public void paSetOintField(java.lang.String fn,
                           java.lang.Integer value)
                    throws PException

It assigns the value to an Integer field.

Parameters:: fn - A String containing the name of the field to be set.; value - The Integer value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetLongField

public void paSetLongField(java.lang.String fn,
                           long value)
                    throws PException

It assigns the value to a long field.

Parameters:: fn - A String containing the name of the field to be set.; value - The long value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetOlongField

public void paSetOlongField(java.lang.String fn,
                            java.lang.Long value)
                     throws PException

It assigns the value to a Long field.

Parameters:: fn - A String containing the name of the field to be set.; value - The Long value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetFloatField

public void paSetFloatField(java.lang.String fn,
                            float value)
                     throws PException

It assigns the value to a float field.

Parameters:: fn - A String containing the name of the field to be set.; value - The float value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetOfloatField

public void paSetOfloatField(java.lang.String fn,
                             java.lang.Float value)
                      throws PException

It assigns the value to a Float field.

Parameters:: fn - A String containing the name of the field to be set.; value - The Float value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetDoubleField

public void paSetDoubleField(java.lang.String fn,
                             double value)
                      throws PException

It assigns the value to a double field.

Parameters:: fn - A String containing the name of the field to be set.; value - The double value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetOdoubleField

public void paSetOdoubleField(java.lang.String fn,
                              java.lang.Double value)
                       throws PException

It assigns the value to a Double field.

Parameters:: fn - A String containing the name of the field to be set.; value - The Double value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetStringField

public void paSetStringField(java.lang.String fn,
                             java.lang.String value)
                      throws PException

It assigns the value to a string field.

Parameters:: fn - A String containing the name of the field to be set.; value - The java.lang.String value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetDateField

public void paSetDateField(java.lang.String fn,
                           java.util.Date value)
                    throws PException

It assigns the value to a date field.

Parameters:: fn - A String containing the name of the field to be set.; value - The java.sql.Date value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetSerializedField

public void paSetSerializedField(java.lang.String fn,
                                 java.io.Serializable value)
                          throws PException

It assigns the value to a serialized field.

Parameters:: fn - A String containing the name of the field to be set.; value - The java.io.Serializable value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetBigDecimalField

public void paSetBigDecimalField(java.lang.String fn,
                                 java.math.BigDecimal value)
                          throws PException

It assigns the value to a BigDecimal field.

Parameters:: fn - A String containing the name of the field to be set.; value - The java.math.BigDecimal value to assign.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.

paSetRefField

public void paSetRefField(java.lang.String fn,
                          java.lang.Object value,
                          java.lang.Object connection)
                   throws PException

It assigns the value to a reference field.

Parameters:: fn - A String containing the name of the field to be set.; value - The reference value to assign.; connection - The connection to access to support. This connection can be used to resolve a pname for example.
Throws:: PExceptionTyping - There is no field with this name and this type within this JORM class.