Klasse SQLField

java.lang.Object

com.inet.report.Field

com.inet.report.SQLField

Alle implementierten Schnittstellen:

NodeParser, com.inet.report.ReferencedObject, com.inet.report.ReferenceHolder, Validatable, 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.

Siehe auch:

• Serialisierte Form

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen Field

Field.FieldAttributeTag

Feldübersicht

Von Klasse geerbte Felder 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

Methodenübersicht

Modifikator und Typ	Methode	Beschreibung
final void	addReferencedObject(com.inet.report.ReferencedObject reference)	FOR INTERNAL USE ONLY
void	changeAliasName(String oldAlias, String newAlias)	FOR INTERNAL USE ONLY
Field	duplicate(String copyName)	Duplicates this field with all its settings and returns the created Field with the given name.
Datasource	getDatasource()	Returns the datasource.
final int	getRealReferencedObjectCount()	FOR INTERNAL USE ONLY
final int	getReferencedObjectCount()	FOR INTERNAL USE ONLY
final com.inet.report.ReferencedObject[]	getReferencedObjects()	FOR INTERNAL USE ONLY
String	getSQLExpression()	Returns the value of the property 'SQL expression text'.
boolean	isUsed()	FOR INTERNAL USE ONLY
NodeParser	parseElement(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String,Object> parserMap)	FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML
void	parseText(String text, Map<String,Object> parserMap)	FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML
final void	removeReferencedObject(com.inet.report.ReferencedObject reference)	FOR INTERNAL USE ONLY
final void	resetReferences()	FOR INTERNAL USE ONLY
protected void	saveFieldXML2(PrintWriter pw, int depth)	FOR INTERNAL USE ONLY
void	setName(String name)	Sets the name of the SQL field.
final void	setReferences()	FOR INTERNAL USE ONLY
void	setSQLExpression(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.

Von Klasse geerbte Methoden Field

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

Von Klasse geerbte Methoden Object

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

Methodendetails

setName

public void setName(String name)
             throws ReportException

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

Angegeben von:

setName in Klasse Field

Parameter:

name - Name of the SQL field

Löst aus:

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

IllegalArgumentException - is thrown when the name already exists.

Seit:

6.0

getSQLExpression

public String getSQLExpression()

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

Gibt zurück:

The value of the property 'SQL expression text'.

Seit:

6.0

setSQLExpression

public void setSQLExpression(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.

Parameter:

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

Löst aus:

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

Seit:

6.0

changeAliasName

public void changeAliasName(String oldAlias,
 String newAlias)

FOR INTERNAL USE ONLY

saveFieldXML2

protected void saveFieldXML2(PrintWriter pw,
 int depth)

FOR INTERNAL USE ONLY

Angegeben von:

saveFieldXML2 in Klasse Field

Parameter:

pw - the print writer

depth - the current depth

addReferencedObject

public final void addReferencedObject(com.inet.report.ReferencedObject reference)

FOR INTERNAL USE ONLY

Angegeben von:

addReferencedObject in Schnittstelle com.inet.report.ReferenceHolder

Seit:

6.0

getReferencedObjects

public final com.inet.report.ReferencedObject[] getReferencedObjects()

FOR INTERNAL USE ONLY

Angegeben von:

getReferencedObjects in Schnittstelle com.inet.report.ReferenceHolder

Seit:

6.0

getRealReferencedObjectCount

public final int getRealReferencedObjectCount()

FOR INTERNAL USE ONLY

Angegeben von:

getRealReferencedObjectCount in Schnittstelle com.inet.report.ReferenceHolder

Seit:

6.0

getReferencedObjectCount

public final int getReferencedObjectCount()

FOR INTERNAL USE ONLY

Angegeben von:

getReferencedObjectCount in Schnittstelle com.inet.report.ReferenceHolder

removeReferencedObject

public final void removeReferencedObject(com.inet.report.ReferencedObject reference)

FOR INTERNAL USE ONLY

Angegeben von:

removeReferencedObject in Schnittstelle com.inet.report.ReferenceHolder

setReferences

public final void setReferences()

FOR INTERNAL USE ONLY

Angegeben von:

setReferences in Schnittstelle com.inet.report.ReferenceHolder

resetReferences

public final void resetReferences()

FOR INTERNAL USE ONLY

Angegeben von:

resetReferences in Schnittstelle com.inet.report.ReferenceHolder

isUsed

public boolean isUsed()

FOR INTERNAL USE ONLY

Setzt außer Kraft:

isUsed in Klasse Field

Seit:

6.0

parseElement

public NodeParser parseElement(com.inet.report.parser.XMLTag group,
 String tag,
 Attributes atts,
 Map<String,Object> parserMap)
                        throws FatalParserException

FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML

Parses an XML node with the given information, and returns either a sub-element which was created as a result, or null if no sub-element was created, i.e. the information was applied to the ReportComponent itself. Note that the parsing is highly tolerant, i.e. exceptions are intercepted and suppressed if at all possible.

Angegeben von:

parseElement in Schnittstelle NodeParser

Setzt außer Kraft:

parseElement in Klasse Field

Parameter:

group - XMLTag of the current node to be parsed, or null if there is no such current group. An XMLTag is a group of nodes bundled together, usually it is a Properties node such as CommonProperties, BorderProperties, etc.

tag - The XMLTag to be parsed

atts - The set of attributes in the current XMLTag

parserMap - The map of current Parser.

Gibt zurück:

The NodeParser sub-element if one needed to be created, or null if none was created.

Löst aus:

FatalParserException - if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.

parseText

public void parseText(String text,
 Map<String,Object> parserMap)

FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML

This method is called if text was encountered in the context of this node. (Examples would be a formula's text or a text element's text)

Angegeben von:

parseText in Schnittstelle NodeParser

Setzt außer Kraft:

parseText in Klasse Field

Parameter:

text - text encountered and to be stored

parserMap - The map of current Parser.

duplicate

public Field duplicate(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.

Setzt außer Kraft:

duplicate in Klasse Field

Parameter:

copyName - the name the created field should have.

Gibt zurück:

the duplicated field.

getDatasource

public Datasource getDatasource()

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

Gibt zurück:

the datasource (not null)

Seit:

9.2

validate

public Validity validate()

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

Angegeben von:

validate in Schnittstelle Validatable

Gibt zurück:

the current state, never null.