Package org.eclipse.persistence.queries

Class FieldResult

java.lang.Object

org.eclipse.persistence.queries.FieldResult

All Implemented Interfaces:

java.io.Serializable

public class FieldResult
extends java.lang.Object
implements java.io.Serializable

Purpose: Concrete class to represent the FieldResult structure as defined by the EJB 3.0 Persistence specification. This class is a subcomponent of the EntityResult.

Since:

TopLink Java Essentials

Author:

Gordon Yorke

See Also:

EntityResult, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	attributeName	Stores the name of the bean attribute
protected DatabaseField	column	Stores the Columns name from the result set that contains the attribute value
protected java.lang.String[]	multipleFieldIdentifiers	Stores passed in field name split on the '.' character

Constructor Summary

Constructors

Constructor	Description
FieldResult(java.lang.String attributeName, java.lang.String columnName)
FieldResult(java.lang.String attributeName, DatabaseField column)

Method Summary

Modifier and Type	Method	Description
void	add(FieldResult newFieldResult)	INTERNAL: This method is used to support mapping multiple fields, fields are concatenated/added to one fieldResult.
java.lang.String	getAttributeName()
DatabaseField	getColumn()
java.util.Vector<FieldResult>	getFieldResults()	INTERNAL:
java.lang.String[]	getMultipleFieldIdentifiers()	INTERNAL:
java.lang.Object	getValueFromRecord(DatabaseRecord record)	INTERNAL: This method is a convenience method for extracting values from Results

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

attributeName

protected java.lang.String attributeName

Stores the name of the bean attribute

multipleFieldIdentifiers

protected java.lang.String[] multipleFieldIdentifiers

Stores passed in field name split on the '.' character

column

protected DatabaseField column

Stores the Columns name from the result set that contains the attribute value

Constructor Detail

FieldResult

public FieldResult(java.lang.String attributeName,
                   java.lang.String columnName)

FieldResult

public FieldResult(java.lang.String attributeName,
                   DatabaseField column)

Method Detail

getAttributeName

public java.lang.String getAttributeName()

getColumn

public DatabaseField getColumn()

getValueFromRecord

public java.lang.Object getValueFromRecord(DatabaseRecord record)

INTERNAL: This method is a convenience method for extracting values from Results

getFieldResults

public java.util.Vector<FieldResult> getFieldResults()

INTERNAL:

getMultipleFieldIdentifiers

public java.lang.String[] getMultipleFieldIdentifiers()

INTERNAL:

add

public void add(FieldResult newFieldResult)

INTERNAL: This method is used to support mapping multiple fields, fields are concatenated/added to one fieldResult.