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

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

Method Details

pngetBigDecimalField

public BigDecimal pngetBigDecimalField(String fn,
                                       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.


pngetBigIntegerField

public BigInteger pngetBigIntegerField(String fn,
                                       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.


pngetByteArrayField

public byte[] pngetByteArrayField(String fn,
                                  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.


pngetByteField

public byte pngetByteField(String fn,
                           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.


pngetCharArrayField

public char[] pngetCharArrayField(String fn,
                                  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.


pngetCharField

public char pngetCharField(String fn,
                           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.


pngetDateField

public Date pngetDateField(String fn,
                           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.


pngetIntField

public int pngetIntField(String fn,
                         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.


pngetLongField

public long pngetLongField(String fn,
                           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.


pngetObyteField

public Byte pngetObyteField(String fn,
                            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.


pngetOcharField

public Character pngetOcharField(String fn,
                                 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.


pngetOintField

public Integer pngetOintField(String fn,
                              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.


pngetOlongField

public Long pngetOlongField(String fn,
                            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.


pngetOshortField

public Short pngetOshortField(String fn,
                              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.


pngetShortField

public short pngetShortField(String fn,
                             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.


pngetStringField

public String pngetStringField(String fn,
                               Object ctxt)
            throws PException
It retrieves the value of a string 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.lang.String value of the field as stored within the composite name.