com.inet.report

Class SQLField

java.lang.Object

com.inet.report.Field

com.inet.report.SQLField

All Implemented Interfaces:

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

public class SQLField
extends Field
implements com.inet.report.ReferenceHolder, Validatable

This class represents a field for SQL statements.

This class is part of the RDC.

See Also:

Serialized Form

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 and Description
Field	duplicate(java.lang.String copyName) Duplicates this field with all its settings and returns the created Field with the given name.
Datasource	getDatasource() Returns the datasource.
java.lang.String	getSQLExpression() Returns the value of the property 'SQL expression text'.
void	setName(java.lang.String name) Sets the name of the SQL field.
void	setSQLExpression(java.lang.String formula) Sets the value of the property 'SQL expression text'.
Validity	validate() Check if the object is valid and returns the state and details of possible errors.

Methods inherited from class com.inet.report.Field

checkNameExists, extractReference, getField, getGroup, getName, getPlaceholderName, getRefName, getType, getValueType, indexOf, paramString, setField, setGroup, setValueType, trimAwayBrackets

Methods inherited from interface com.inet.report.parser.NodeParser

isDOMParser, parseDOM, parseElement, parseEndElement, parseText

Method Detail

setName

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

Sets the name of the SQL field. The name does not exists already, otherwise an exception will be thrown.

Specified by:

setName in class Field

Parameters:

name - Name of the SQL field

Throws:

ReportException - is thrown when name == null or name.length() == 0

java.lang.IllegalArgumentException - is thrown when the name already exists.

Since:

6.0

getSQLExpression

public java.lang.String getSQLExpression()

Returns the value of the property 'SQL expression text'.

Returns:

The value of the property 'SQL expression text'.

Since:

6.0

setSQLExpression

public void setSQLExpression(java.lang.String formula)
                      throws ReportException

Sets the value of the property 'SQL expression text'. The value type of the result of this SQL expression is fetched by the configured database.

Parameters:

formula - The new value of the property 'SQL expression text'.

Throws:

ReportException - is thrown if the SQL expression contains errors or a connection to the configured database fails.

Since:

6.0

duplicate

public Field duplicate(java.lang.String copyName)

Duplicates this field with all its settings and returns the created Field with the given name. Note that the new formula field will not initially be referenced by any other report objects. If you duplicate a property formula, you will have to set the new formula as a separate property formula.

Overrides:

duplicate in class Field

Parameters:

copyName - the name the created field should have.

Returns:

the duplicated field.

getDatasource

public Datasource getDatasource()

Returns the datasource. This field use the datasource to get data from the database.

Returns:

the datasource (not null)

Since:

9.2

validate

public Validity validate()

Check if the object is valid and returns the state and details of possible errors.

Specified by:

validate in interface Validatable

Returns:

the current state, never null.