Package com.inet.report

Class DatabaseField

java.lang.Object

com.inet.report.Field

com.inet.report.DatabaseField

All Implemented Interfaces:

NodeParser, com.inet.report.ReferencedObject, java.io.Serializable

public class DatabaseField
extends Field

This class represents a database field.
A DatabaseField holds the information needed to use a field from a database table.
When a field will be evaluated the data of the field are fetched for each record in the table. Therefore the full name of the field in the database table is needed, i.e. "People.Phonenumber". Set it when adding the field to the table source with the method TableSource.addColumn(String, int) in class TableSource or with method setName(String). The short name is an alias for the full name, i.e. Phonenumber.
Adding and removing of a DatabaseField is handled by class TableSource. You can use the following methods to add a database field to an existing report:
engine.getDatabaseTables().getDataSource(string).getTableSource(int or string).addColumn(String, int).
Getting of a DatabaseField is handled by class Fields. You can use the following method to get a database field of an existing report:
engine.getFields().getDatabaseField(int or string).
To print the fetched data in the report you have to fill it into a FieldElement or FieldPart.

This class is part of the RDC.

Since:

1.0

See Also:

Fields.getDatabaseFieldsCount(), Fields.getDatabaseField(int), Fields.getDatabaseField(String), Fields.removeDatabaseField(int), FieldElement, FieldPart, TableSource.addColumn(String, int), TableSource.getDatabaseField(String), TableSource.removeColumn(String), Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.inet.report.Field

Field.FieldAttributeTag

Field Summary

Fields inherited from class com.inet.report.Field

BINARY, BOOLEAN, CURRENCY, CURSOR, DATABASE_FIELD, DATE, DATETIME, FORMULA_FIELD, GROUP_NAME_FIELD, NUMBER, PARAMETER_FIELD, SORT_FIELD, SPECIAL_FIELD, SQL_FIELD, STRING, SUMMARY_FIELD, TIME, UNKNOWN

Method Summary

Modifier and Type	Method	Description
java.lang.String	getColumnLabel()	Returns the label of this DatabaseField.
java.lang.String	getShortName()	Returns the short name of a database field. This is the name of the database-column without leading table-name, i.e. the name of the database field is 'Customers.Customer ID', the short name should be 'Customer ID'.
TableSource	getTableSource()	Returns the table source this database field is based on, will never return null.
boolean	hasColumnLabel()	Returns whether a column label was set or not.
void	rename(java.lang.String newName)	FOR INTERNAL USE ONLY
protected void	saveFieldXML2(java.io.PrintWriter pw, int depth)	FOR INTERNAL USE ONLY
void	setColumnLabel(java.lang.String columnLabel)	Specifies an alias for table columns.
void	setName(java.lang.String fullname)	Specifies the name of the DatabaseField. The name have to start with the name of the table separated with a dot, i.e. table.column. The short name of this field is set to the name of the column.
java.lang.String	toString()

Methods inherited from class com.inet.report.Field

addReferenceHolder, checkNameExists, duplicate, equals, extractReference, getField, getGroup, getName, getPlaceholderName, getRealReferenceCount, getReferenceHolderCount, getReferenceHolders, getRefName, getType, getValueType, indexOf, isDOMParser, isUsed, paramString, parseDOM, parseElement, parseEndElement, parseText, removeReferenceHolder, setField, setGroup, setValueType, trimAwayBrackets

Methods inherited from class java.lang.Object

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

Method Detail

setName

public void setName(java.lang.String fullname)
             throws ReportException

Specifies the name of the DatabaseField.
The name have to start with the name of the table separated with a dot, i.e. table.column.
The short name of this field is set to the name of the column. The value type of the database field will be read from the database.

Specified by:

setName in class Field

Parameters:

fullname - The qualified column name for this database field.

Throws:

ReportException - If the alias or table name was missing.

java.lang.IllegalArgumentException - If the database field name was empty

Since:

1.0

setColumnLabel

public void setColumnLabel(java.lang.String columnLabel)

Specifies an alias for table columns. The label is an additional information. It can be used to explain abstract column names. This label will be used from i-net Designer for example. It don't influence the SQL generation.

Parameters:

columnLabel - Label of the database field

Since:

6.0

See Also:

getColumnLabel(), hasColumnLabel()

getColumnLabel

public java.lang.String getColumnLabel()

Returns the label of this DatabaseField. The label is an additional information only. It can be used to explain abstract column names. This label will be used from i-net Designer for example.

Returns:

Label of the database field as String.

Since:

6.0

See Also:

getColumnLabel(), hasColumnLabel()

hasColumnLabel

public boolean hasColumnLabel()

Returns whether a column label was set or not.

Returns:

true if a column label was set, false otherwise.

Since:

6.0

See Also:

setColumnLabel(String), getColumnLabel()

getShortName

public java.lang.String getShortName()

Returns the short name of a database field.
This is the name of the database-column without leading table-name, i.e. the name of the database field is 'Customers.Customer ID', the short name should be 'Customer ID'.

Returns:

The short name of the database field as String.

Since:

1.0

rename

public void rename(java.lang.String newName)
            throws ReportException

FOR INTERNAL USE ONLY

Overrides:

rename in class Field

Throws:

ReportException

saveFieldXML2

protected void saveFieldXML2(java.io.PrintWriter pw,
                             int depth)

FOR INTERNAL USE ONLY

Specified by:

saveFieldXML2 in class Field

Parameters:

pw - the print writer

depth - the current depth

getTableSource

public TableSource getTableSource()

Returns the table source this database field is based on, will never return null.

Returns:

TableSource this database field is based on, never null

Since:

7.0

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object