com.aspc.DBObj.Query

Class DBQueryColumn

java.lang.Object

com.aspc.DBObj.Query.DBQueryColumn

public class DBQueryColumn
extends java.lang.Object

DBQueryColumn is a
THREAD MODE: SINGLE-THREADED

Since:

January 30, 2007, 10:27 AM

Author:

Jason McGrath

Constructor Summary

Constructors

Constructor and Description
DBQueryColumn(Path path, java.lang.String displayFormat) Constructs a DBQueryColumn.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayFormat() Returns the display format used for displaying target field value
Path	getPath() Returns the associated Path
java.lang.String	getString(DBObject base) Retrieves the String value from the supplied base object in the correct display format
DBField	getTargetField() The target field of the Path

Methods inherited from class java.lang.Object

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

Constructor Detail

DBQueryColumn

public DBQueryColumn(Path path,
                     java.lang.String displayFormat)

Constructs a DBQueryColumn.

Parameters:

path - The path to the field to be retrieved

displayFormat - (Optional)The format that the field value should be retrieve in

Method Detail

getPath

public Path getPath()

Returns the associated Path

Returns:

Path

getTargetField

public DBField getTargetField()

The target field of the Path

Returns:

target field

getDisplayFormat

public java.lang.String getDisplayFormat()

Returns the display format used for displaying target field value

Returns:

Display Format

getString

public java.lang.String getString(DBObject base)
                           throws java.lang.Exception

Retrieves the String value from the supplied base object in the correct display format

Parameters:

base - The base object to retrieve the value from

Returns:

target field value

Throws:

java.lang.Exception - - The value could not be retrieved