org.objectweb.jorm.naming.api
Interface PNameGetter


public interface PNameGetter

The PNameGetter interface defines a generic accessor to be used by persistent bindings to access fields of composite names it manages.

Author:
P. Dechamboux

Method Summary
 java.math.BigDecimal pngetBigDecimalField(java.lang.String fn, java.lang.Object ctxt)
          It retrieves the value of a BigDecimal field.
 java.math.BigInteger pngetBigIntegerField(java.lang.String fn, java.lang.Object ctxt)
          It retrieves the value of a BigInteger field.
 byte[] pngetByteArrayField(java.lang.String fn, java.lang.Object ctxt)
          It retrieves the value of a byte[] field.
 byte pngetByteField(java.lang.String fn, java.lang.Object ctxt)
          It retrieves the value of a byte field.
 char[] pngetCharArrayField(java.lang.String fn, java.lang.Object ctxt)
          It retrieves the value of a char[] field.
 char pngetCharField(java.lang.String fn, java.lang.Object ctxt)
          It retrieves the value of a char field.
 java.util.Date pngetDateField(java.lang.String fn, java.lang.Object ctxt)
          It retrieves the value of a date field.
 int pngetIntField(java.lang.String fn, java.lang.Object ctxt)
          It retrieves the value of an int field.
 long pngetLongField(java.lang.String fn, java.lang.Object ctxt)
          It retrieves the value of a long field.
 java.lang.Byte pngetObyteField(java.lang.String fn, java.lang.Object ctxt)
          It retrieves the value of a Byte field.
 java.lang.Character pngetOcharField(java.lang.String fn, java.lang.Object ctxt)
          It retrieves the value of a Character field.
 java.lang.Integer pngetOintField(java.lang.String fn, java.lang.Object ctxt)
          It retrieves the value of an Integer field.
 java.lang.Long pngetOlongField(java.lang.String fn, java.lang.Object ctxt)
          It retrieves the value of a Long field.
 java.lang.Short pngetOshortField(java.lang.String fn, java.lang.Object ctxt)
          It retrieves the value of a Short field.
 short pngetShortField(java.lang.String fn, java.lang.Object ctxt)
          It retrieves the value of a short field.
 java.lang.String pngetStringField(java.lang.String fn, java.lang.Object ctxt)
          It retrieves the value of a string field.
 

Method Detail

pngetByteField

public byte pngetByteField(java.lang.String fn,
                           java.lang.Object ctxt)
                    throws PException
It retrieves the value of a byte field.

Parameters:
fn - A String containing the name of the field.
ctxt - A context used by PNameGetter to extract the related data.
Returns:
The byte value of the field as stored within the composite name.
Throws:
PExceptionTyping - There is no field with this name and this type within this composite name.
PExceptionIO - It is raised when a problem occurs while potentially accessing the DSI.
PException

pngetObyteField

public java.lang.Byte pngetObyteField(java.lang.String fn,
                                      java.lang.Object ctxt)
                               throws PException
It retrieves the value of a Byte field.

Parameters:
fn - A String containing the name of the field.
ctxt - A context used by PNameGetter to extract the related data.
Returns:
The Byte value of the field as stored within the composite name.
Throws:
PExceptionTyping - There is no field with this name and this type within this composite name.
PExceptionIO - It is raised when a problem occurs while potentially accessing the DSI.
PException

pngetCharField

public char pngetCharField(java.lang.String fn,
                           java.lang.Object ctxt)
                    throws PException
It retrieves the value of a char field.

Parameters:
fn - A String containing the name of the field.
ctxt - A context used by PNameGetter to extract the related data.
Returns:
The char value of the field as stored within the composite name.
Throws:
PExceptionTyping - There is no field with this name and this type within this composite name.
PExceptionIO - It is raised when a problem occurs while potentially accessing the DSI.
PException

pngetOcharField

public java.lang.Character pngetOcharField(java.lang.String fn,
                                           java.lang.Object ctxt)
                                    throws PException
It retrieves the value of a Character field.

Parameters:
fn - A String containing the name of the field.
ctxt - A context used by PNameGetter to extract the related data.
Returns:
The Character value of the field as stored within the composite name.
Throws:
PExceptionTyping - There is no field with this name and this type within this composite name.
PExceptionIO - It is raised when a problem occurs while potentially accessing the DSI.
PException

pngetShortField

public short pngetShortField(java.lang.String fn,
                             java.lang.Object ctxt)
                      throws PException
It retrieves the value of a short field.

Parameters:
fn - A String containing the name of the field.
ctxt - A context used by PNameGetter to extract the related data. In in the case of RDB, it can be the result set.
Returns:
The short value of the field as stored within the composite name.
Throws:
PExceptionTyping - There is no field with this name and this type within this composite name.
PExceptionIO - It is raised when a problem occurs while potentially accessing the DSI.
PException

pngetOshortField

public java.lang.Short pngetOshortField(java.lang.String fn,
                                        java.lang.Object ctxt)
                                 throws PException
It retrieves the value of a Short field.

Parameters:
fn - A String containing the name of the field.
ctxt - A context used by PNameGetter to extract the related data.
Returns:
The Short value of the field as stored within the composite name.
Throws:
PExceptionTyping - There is no field with this name and this type within this composite name.
PExceptionIO - It is raised when a problem occurs while potentially accessing the DSI.
PException

pngetIntField

public int pngetIntField(java.lang.String fn,
                         java.lang.Object ctxt)
                  throws PException
It retrieves the value of an int field.

Parameters:
fn - A String containing the name of the field.
ctxt - A context used by PNameGetter to extract the related data.
Returns:
The int value of the field as stored within the composite name.
Throws:
PExceptionTyping - There is no field with this name and this type within this composite name.
PExceptionIO - It is raised when a problem occurs while potentially accessing the DSI.
PException

pngetOintField

public java.lang.Integer pngetOintField(java.lang.String fn,
                                        java.lang.Object ctxt)
                                 throws PException
It retrieves the value of an Integer field.

Parameters:
fn - A String containing the name of the field.
ctxt - A context used by PNameGetter to extract the related data.
Returns:
The Integer value of the field as stored within the composite name.
Throws:
PExceptionTyping - There is no field with this name and this type within this composite name.
PExceptionIO - It is raised when a problem occurs while potentially accessing the DSI.
PException

pngetLongField

public long pngetLongField(java.lang.String fn,
                           java.lang.Object ctxt)
                    throws PException
It retrieves the value of a long field.

Parameters:
ctxt - A context used by PNameGetter to extract the related data.
fn - A String containing the name of the field.
Returns:
The long value of the field as stored within the composite name.
Throws:
PExceptionTyping - There is no field with this name and this type within this composite name.
PExceptionIO - It is raised when a problem occurs while potentially accessing the DSI.
PException

pngetOlongField

public java.lang.Long pngetOlongField(java.lang.String fn,
                                      java.lang.Object ctxt)
                               throws PException
It retrieves the value of a Long field.

Parameters:
fn - A String containing the name of the field.
ctxt - A context used by PNameGetter to extract the related data.
Returns:
The Long value of the field as stored within the composite name.
Throws:
PExceptionTyping - There is no field with this name and this type within this composite name.
PExceptionIO - It is raised when a problem occurs while potentially accessing the DSI.
PException

pngetStringField

public java.lang.String pngetStringField(java.lang.String fn,
                                         java.lang.Object ctxt)
                                  throws PException
It retrieves the value of a string field.

Parameters:
ctxt - A context used by PNameGetter to extract the related data.
fn - A String containing the name of the field.
Returns:
The java.lang.String value of the field as stored within the composite name.
Throws:
PExceptionTyping - There is no field with this name and this type within this composite name.
PExceptionIO - It is raised when a problem occurs while potentially accessing the DSI.
PException

pngetByteArrayField

public byte[] pngetByteArrayField(java.lang.String fn,
                                  java.lang.Object ctxt)
                           throws PException
It retrieves the value of a byte[] field.

Parameters:
ctxt - A context used by PNameGetter to extract the related data.
fn - A String containing the name of the field.
Returns:
The byte[] value of the field as stored within the composite name.
Throws:
PExceptionTyping - There is no field with this name and this type within this composite name.
PExceptionIO - It is raised when a problem occurs while potentially accessing the DSI.
PException

pngetCharArrayField

public char[] pngetCharArrayField(java.lang.String fn,
                                  java.lang.Object ctxt)
                           throws PException
It retrieves the value of a char[] field.

Parameters:
ctxt - A context used by PNameGetter to extract the related data.
fn - A String containing the name of the field.
Returns:
The char[] value of the field as stored within the composite name.
Throws:
PExceptionTyping - There is no field with this name and this type within this composite name.
PExceptionIO - It is raised when a problem occurs while potentially accessing the DSI.
PException

pngetDateField

public java.util.Date pngetDateField(java.lang.String fn,
                                     java.lang.Object ctxt)
                              throws PException
It retrieves the value of a date field.

Parameters:
fn - A String containing the name of the field.
ctxt - A context used by PNameGetter to extract the related data.
Returns:
The java.util.Date value of the field as stored within the composite name.
Throws:
PExceptionTyping - There is no field with this name and this type within this composite name.
PExceptionIO - It is raised when a problem occurs while potentially accessing the DSI.
PException

pngetBigIntegerField

public java.math.BigInteger pngetBigIntegerField(java.lang.String fn,
                                                 java.lang.Object ctxt)
                                          throws PException
It retrieves the value of a BigInteger field.

Parameters:
fn - A String containing the name of the field.
ctxt - A context used by PNameGetter to extract the related data.
Returns:
The java.math.BigInteger value of the field as stored within the composite name.
Throws:
PExceptionTyping - There is no field with this name and this type within this composite name.
PExceptionIO - It is raised when a problem occurs while potentially accessing the DSI.
PException

pngetBigDecimalField

public java.math.BigDecimal pngetBigDecimalField(java.lang.String fn,
                                                 java.lang.Object ctxt)
                                          throws PException
It retrieves the value of a BigDecimal field.

Parameters:
fn - A String containing the name of the field.
ctxt - A context used by PNameGetter to extract the related data.
Returns:
The java.math.BigDecimal value of the field as stored within the composite name.
Throws:
PExceptionTyping - There is no field with this name and this type within this composite name.
PExceptionIO - It is raised when a problem occurs while potentially accessing the DSI.
PException