Package com.inet.report
Class Field
java.lang.Object
com.inet.report.Field
- All Implemented Interfaces:
NodeParser
,com.inet.report.ReferencedObject
,Serializable
- Direct Known Subclasses:
DatabaseField
,Fields.UnknownField
,FormulaField
,GroupField
,PromptField
,SortField
,SpecialField
,SQLField
,SummaryField
public abstract class Field
extends Object
implements Serializable, com.inet.report.ReferencedObject, NodeParser
Field
is the superclass of the different types of fields which can be used in a report. It summarizes the properties shared by all fields. A field is dynamic content in a report, it
will be evaluated at runtime and deliver static content (text, picture, ...) for each record to the element that uses the field. I.e. if you want to insert a dynamic label into your report, you
have to use a FieldElement
or a Text
with a FieldPart
. Both FieldElement
and FieldPart
get their content from a
Field
. For each kind of source there is a specialized subclass. There are SpecialField
s for contents like 'page number' and 'current date/time',
DatabaseField
s for content that comes from a database, PromptField
s for content that the user will be asked for at runtime, FormulaField
s for content
that is calculated by a formula, ... .All fields are collected within the class
Fields
, so you can not create an instance of Field
or subclasses. If you want to instantiate a field by name, the name of the field should start with a special character:
- no character, if the field is a
DatabaseField
- a '%', if the field is a
SqlExprField
- a '#', if the field is a
SummaryField
- a '@', if the field is a
FormulaField
- a '?', if the field is a
PromptField
- Since:
- 6.0
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The constant that identifies a Binary value.static final int
The constant that identifies a Boolean value.static final int
The constant that identifies a Currency value.static final int
The constant that identifies a Cursor value.static final int
Field is a database field.static final int
The constant that identifies a Date value.static final int
The constant that identifies a DateTime value.static final int
Field is a formula field.static final int
Field is a group name field.static final int
The constant that identifies a Number value.static final int
Field is a parameter field.static final int
Field is a sort field.static final int
Field is a special field.static final int
Field is a sql field.static final int
The constant that identifies a String value.static final int
Field is a summary field.static final int
The constant that identifies a Time value.static final int
The constant that identifies an unspecific type. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addReferenceHolder
(com.inet.report.ReferenceHolder holder) FOR INTERNAL USE ONLYboolean
checkNameExists
(String nameToCheck) Checks whether the string name is the property 'name' of the field.Duplicates this field with all its settings and returns the created Field with the given name.boolean
protected void
extractReference
(Attributes atts) extracts the referenced field and sets it for this Field objectgetField()
Gets the field definition element (for example, database field element, prompt field element).getGroup()
Returns the group this field is associated with.getName()
Returns the value of the property 'name'.Returns the placeholder of this field including its brackets, required to use the field in formulas and sql statements.int
FOR INTERNAL USE ONLYint
FOR INTERNAL USE ONLYcom.inet.report.ReferenceHolder[]
FOR INTERNAL USE ONLYReturns the value of the property 'name' with a type marker.int
getType()
Returns the value of the property 'type'.int
Returns the value type (or return type) of the field.
NOTE:If DefaultAttribute is used within the formula it has to be set before calling this method.int
indexOf()
Returns the index of the field in the fields set.boolean
FOR INTERNAL USE ONLY Internal method for reading report XMLboolean
isUsed()
FOR INTERNAL USE ONLYReturns a prettified output of this field's name and type.void
FOR INTERNAL USE ONLY Internal method for reading report XMLparseElement
(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String, Object> parserMap) FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
parseEndElement
(com.inet.report.parser.XMLTag group, String tag, Map<String, Object> parserMap) FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
removeReferenceHolder
(com.inet.report.ReferenceHolder holder) FOR INTERNAL USE ONLYvoid
FOR INTERNAL USE ONLYprotected abstract void
saveFieldXML2
(PrintWriter pw, int depth) XML2: FOR INTERNAL USE ONLYvoid
Sets the field definition element (for example, DatabaseField element, prompt field element).void
Sets the group this field should associated with.abstract void
Sets the value of the property 'name'.void
setValueType
(int newValue) Sets the value of the property 'value type'.protected String
trimAwayBrackets
(String refname) trims away "{" before and after string, e.g.
-
Field Details
-
NUMBER
public static final int NUMBERThe constant that identifies a Number value.- See Also:
-
CURRENCY
public static final int CURRENCYThe constant that identifies a Currency value.- See Also:
-
BOOLEAN
public static final int BOOLEANThe constant that identifies a Boolean value.- See Also:
-
DATE
public static final int DATEThe constant that identifies a Date value.- See Also:
-
TIME
public static final int TIMEThe constant that identifies a Time value.- See Also:
-
STRING
public static final int STRINGThe constant that identifies a String value.- See Also:
-
BINARY
public static final int BINARYThe constant that identifies a Binary value.- See Also:
-
DATETIME
public static final int DATETIMEThe constant that identifies a DateTime value.- See Also:
-
CURSOR
public static final int CURSORThe constant that identifies a Cursor value.- See Also:
-
UNKNOWN
public static final int UNKNOWNThe constant that identifies an unspecific type.- See Also:
-
DATABASE_FIELD
public static final int DATABASE_FIELDField is a database field.- See Also:
-
FORMULA_FIELD
public static final int FORMULA_FIELDField is a formula field.- See Also:
-
SUMMARY_FIELD
public static final int SUMMARY_FIELDField is a summary field.- See Also:
-
SPECIAL_FIELD
public static final int SPECIAL_FIELDField is a special field.- See Also:
-
GROUP_NAME_FIELD
public static final int GROUP_NAME_FIELDField is a group name field.- See Also:
-
PARAMETER_FIELD
public static final int PARAMETER_FIELDField is a parameter field.- See Also:
-
SORT_FIELD
public static final int SORT_FIELDField is a sort field.- See Also:
-
SQL_FIELD
public static final int SQL_FIELDField is a sql field.- See Also:
-
-
Method Details
-
paramString
Returns a prettified output of this field's name and type.- Returns:
- Prettified output of this field's name and type.
- Since:
- 6.0
-
equals
-
getPlaceholderName
Returns the placeholder of this field including its brackets, required to use the field in formulas and sql statements. To use a field in a formula or in a sql statement, it is necessary to put the placeholder of this field in it.- Returns:
- The placeholder of this field with its brackets, e.g. "{#mySummary}"
- Since:
- 6.0
-
getName
Returns the value of the property 'name'.- Returns:
- The value of the property 'name'.
- Since:
- 6.0
- See Also:
-
setName
Sets the value of the property 'name'.- Parameters:
newValue
-newValue
The new value of the property 'name'.- Throws:
ReportException
- will thrown if the name already exists or is not allowed.- Since:
- 6.0
-
getRefName
Returns the value of the property 'name' with a type marker. This is the name that is used in formulas. For example for the formula 'abc' is the return value '@abc'. -
getField
Gets the field definition element (for example, database field element, prompt field element).- Returns:
Field
The current value of the 'field' property.- Since:
- 6.0
-
setField
Sets the field definition element (for example, DatabaseField element, prompt field element).- Parameters:
newField
- The new field element of the property 'field'.- Since:
- 6.0
-
getType
public int getType()Returns the value of the property 'type'.- Returns:
- The value of the property 'type'.
- Since:
- 6.0
- See Also:
-
getGroup
Returns the group this field is associated with.- Returns:
- Returns the group based on this field if there is one, else
null
. - Since:
- 6.0
- See Also:
-
setGroup
Sets the group this field should associated with. Use this method for setting the group in summary field. GroupFields are generated and initialised automatically at group creation time. You do not need to change the group reference of this fields.- Parameters:
group
- The reference to the group of this field.- Since:
- 6.0
- See Also:
-
getValueType
public int getValueType()Returns the value type (or return type) of the field.
NOTE:If DefaultAttribute is used within the formula it has to be set before calling this method. A null-value will cause an exception here. If you don't know the exact value of the DefaultAttribute you may use a dummy-value for getValueType. The reason is that getValueType only regards the type of object not their value. -
setValueType
public void setValueType(int newValue) Sets the value of the property 'value type'. -
saveFieldXML2
XML2: FOR INTERNAL USE ONLY- Parameters:
pw
- the print writerdepth
- the current depth
-
indexOf
public int indexOf()Returns the index of the field in the fields set. For each field type there is a separate list (DatabaseField, FormulaField, PromptField, SummaryField, SQLField, SortField, GroupField).
Note: Do not call this method for FormulaFields which are either record selection formula, group selection formula or property formulas. If the field was already removed from Engine this will return -1.- Returns:
- The index of the field in the field set of this engine or -1 if the field was already removed from the engine.
- Since:
- 6.0
- See Also:
-
Fields.removeDatabaseField(int)
Fields.removeFormulaField(int)
Fields.removePromptField(int)
Fields.removeSummaryField(int)
Fields.removeSQLField(int)
Fields.removeSortField(int)
Fields.getDatabaseField(int)
Fields.getFormulaField(int)
Fields.getPromptField(int)
Fields.getSummaryField(int)
Fields.getSQLExpressionField(int)
Fields.getSortField(int)
-
isUsed
public boolean isUsed()FOR INTERNAL USE ONLY- Since:
- 6.0
-
checkNameExists
Checks whether the string name is the property 'name' of the field.- Parameters:
nameToCheck
- Name to be checked- Returns:
- true if name equals the field's property 'name'
- Since:
- 6.0
-
addReferenceHolder
public void addReferenceHolder(com.inet.report.ReferenceHolder holder) FOR INTERNAL USE ONLY- Specified by:
addReferenceHolder
in interfacecom.inet.report.ReferencedObject
- Since:
- 6.0
-
getReferenceHolders
public com.inet.report.ReferenceHolder[] getReferenceHolders()FOR INTERNAL USE ONLY- Specified by:
getReferenceHolders
in interfacecom.inet.report.ReferencedObject
-
getReferenceHolderCount
public int getReferenceHolderCount()FOR INTERNAL USE ONLY- Specified by:
getReferenceHolderCount
in interfacecom.inet.report.ReferencedObject
-
getRealReferenceCount
public int getRealReferenceCount()FOR INTERNAL USE ONLY- Specified by:
getRealReferenceCount
in interfacecom.inet.report.ReferencedObject
-
removeReferenceHolder
public void removeReferenceHolder(com.inet.report.ReferenceHolder holder) FOR INTERNAL USE ONLY- Specified by:
removeReferenceHolder
in interfacecom.inet.report.ReferencedObject
- Since:
- 6.0
-
rename
FOR INTERNAL USE ONLY- Throws:
ReportException
- Since:
- 6.0
-
extractReference
extracts the referenced field and sets it for this Field object- Parameters:
atts
- XML attributes containing "name" and "value"- Throws:
ReportException
- If there are problems setting the field- Since:
- 8.0
-
trimAwayBrackets
trims away "{" before and after string, e.g. {abc} => abc- Parameters:
refname
- name to trim- Returns:
- trimmed string
- Since:
- 8.0
-
parseElement
public NodeParser parseElement(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String, Object> parserMap) throws FatalParserExceptionFOR INTERNAL USE ONLY Internal method for reading report XMLParses 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.
- Specified by:
parseElement
in interfaceNodeParser
- Parameters:
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 parsedatts
- The set of attributes in the current XMLTagparserMap
- The map of current Parser.- Returns:
- The NodeParser sub-element if one needed to be created, or null if none was created.
- Throws:
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
FOR INTERNAL USE ONLY Internal method for reading report XMLThis 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)
- Specified by:
parseText
in interfaceNodeParser
- Parameters:
text
- text encountered and to be storedparserMap
- The map of current Parser.
-
parseEndElement
public void parseEndElement(com.inet.report.parser.XMLTag group, String tag, Map<String, Object> parserMap) throws FatalParserExceptionFOR INTERNAL USE ONLY Internal method for reading report XMLReceive notification of the end of an XML tag.
- Specified by:
parseEndElement
in interfaceNodeParser
- Parameters:
group
- XMLTag of the current node to be parsed, or null if there is no such current group.tag
- The XMLTag to be parsedparserMap
- The map of current Parser.- Throws:
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.
-
isDOMParser
public boolean isDOMParser()FOR INTERNAL USE ONLY Internal method for reading report XMLReturns whether this node is to be read via a DOM parser.
- Specified by:
isDOMParser
in interfaceNodeParser
- Returns:
- true if this node is to be read via a DOM parser, false otherwise.
-
parseDOM
FOR INTERNAL USE ONLY Internal method for reading report XMLParses the node.
- Specified by:
parseDOM
in interfaceNodeParser
- Parameters:
node
- the nodeparserMap
- The map of current Parser.- Throws:
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.
-
duplicate
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.- Parameters:
name
- the name the created field should have.- Returns:
- the duplicated field.
- Throws:
IllegalArgumentException
- if an field with the given name already exists .UnsupportedOperationException
- if a field which is not a FormulaField, PromptField, SQLField, or SummaryField is attempted to be duplicated- Since:
- 9.0
-