Package com.inet.report
Class GroupField
java.lang.Object
com.inet.report.Field
com.inet.report.GroupField
- All Implemented Interfaces:
NodeParser
,com.inet.report.ReferencedObject
,com.inet.report.ReferenceHolder
,Validatable
,Serializable
The
You can get the
This class is part of the RDC.
GroupField
represents a group name field, which is automatically created with the creation of a Group
object.
When evaluating a GroupField
the name of the group will returned. So if you have a group
then you can print out the name with a FieldElement
containing the GroupField
.You can get the
GroupField
of each group with Fields.getGroupNameField(int)
in class Fields
.This class is part of the RDC.
-
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 TypeMethodDescriptionfinal void
addReferencedObject
(com.inet.report.ReferencedObject reference) FOR INTERNAL USE ONLYgetField()
Gets the field definition element (for example, database field element, prompt field element).getGroup()
Returns the group this field is associated with.int
Returns the type of the group, which is associated with this group name field.getName()
Returns a string which represents the name of the group field.final int
FOR INTERNAL USE ONLYfinal int
FOR INTERNAL USE ONLYfinal com.inet.report.ReferencedObject[]
FOR INTERNAL USE ONLYint
The return value type of a GroupField is always Field.String, but for formatting the return value type of the group the field is based on is needed.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 XMLfinal void
removeReferencedObject
(com.inet.report.ReferencedObject reference) FOR INTERNAL USE ONLYfinal void
FOR INTERNAL USE ONLYprotected void
saveFieldXML2
(PrintWriter pw, int depth) FOR INTERNAL USE ONLYprotected void
saveXML2GroupField
(PrintWriter pw, int depth) FOR INTERNAL USE ONLYvoid
Sets the field definition element (for example, DatabaseField element, prompt field element).void
Setting the name of a GroupField is not allowed.final void
FOR INTERNAL USE ONLYvalidate()
Check if the object is valid and returns the state and details of possible errors.Methods inherited from class com.inet.report.Field
addReferenceHolder, checkNameExists, duplicate, equals, extractReference, getPlaceholderName, getRealReferenceCount, getReferenceHolderCount, getReferenceHolders, getRefName, getType, indexOf, isDOMParser, isUsed, paramString, parseDOM, parseEndElement, parseText, removeReferenceHolder, rename, setGroup, setValueType, trimAwayBrackets
-
Method Details
-
setName
Setting the name of a GroupField is not allowed. If you want to customize the name of the GroupField use:
GroupField.getGroup().setCustomizeGroupNameField(CUSTOMIZE_GROUP_NAME_FIELD_ENABLED)
andGroupField.getGroup().setGroupNameDbField(<your field>)
- or use
GroupField.getGroup().setCustomizeGroupNameField(CUSTOMIZE_GROUP_NAME_FIELD_ENABLED_WITH_FM)
andGroupField.getGroup().setGroupNameFormula(<your field>)
.
- Specified by:
setName
in classField
- Parameters:
name
- a name.- Throws:
ReportException
- will be thrown when you use this method to set the name of a GroupField.- Since:
- 6.0
- See Also:
-
getGroup
Returns the group this field is associated with. -
getGroupType
public int getGroupType()Returns the type of the group, which is associated with this group name field. The following values possible:- 0 - field results from a standard group definition
- 1 - field results from group definition of a cross-tab column
- 2 - field results from group definition of a cross-tab row
- 3 - field results from group definition of a chart
eng.getGroup(getGroupNumber()+1)
results the Group object which is associated with this field. Otherwise anull
is returned bygetGroup
.- Returns:
- the group type.
- Since:
- 6.0
-
getField
Gets the field definition element (for example, database field element, prompt field element). -
setField
Sets the field definition element (for example, DatabaseField element, prompt field element). -
saveFieldXML2
FOR INTERNAL USE ONLY- Specified by:
saveFieldXML2
in classField
- Parameters:
pw
- the print writerdepth
- the current depth
-
getValueType
public int getValueType()The return value type of a GroupField is always Field.String, but for formatting the return value type of the group the field is based on is needed.- Overrides:
getValueType
in classField
- Returns:
- The value of the property 'value type'.
- Since:
- 6.0
- See Also:
-
getName
Returns a string which represents the name of the group field. The string returned depends on the settings ofGroup.getCustomizeGroupNameField()
. -
addReferencedObject
public final void addReferencedObject(com.inet.report.ReferencedObject reference) FOR INTERNAL USE ONLY- Specified by:
addReferencedObject
in interfacecom.inet.report.ReferenceHolder
- Since:
- 6.0
-
getReferencedObjects
public final com.inet.report.ReferencedObject[] getReferencedObjects()FOR INTERNAL USE ONLY- Specified by:
getReferencedObjects
in interfacecom.inet.report.ReferenceHolder
-
getRealReferencedObjectCount
public final int getRealReferencedObjectCount()FOR INTERNAL USE ONLY- Specified by:
getRealReferencedObjectCount
in interfacecom.inet.report.ReferenceHolder
- Since:
- 6.0
-
getReferencedObjectCount
public final int getReferencedObjectCount()FOR INTERNAL USE ONLY- Specified by:
getReferencedObjectCount
in interfacecom.inet.report.ReferenceHolder
-
removeReferencedObject
public final void removeReferencedObject(com.inet.report.ReferencedObject reference) FOR INTERNAL USE ONLY- Specified by:
removeReferencedObject
in interfacecom.inet.report.ReferenceHolder
- Since:
- 6.0
-
resetReferences
public final void resetReferences()FOR INTERNAL USE ONLY- Specified by:
resetReferences
in interfacecom.inet.report.ReferenceHolder
-
setReferences
public final void setReferences()FOR INTERNAL USE ONLY- Specified by:
setReferences
in interfacecom.inet.report.ReferenceHolder
-
saveXML2GroupField
FOR INTERNAL USE ONLY -
parseElement
public NodeParser parseElement(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String, Object> parserMap) throws FatalParserExceptionFOR INTERNAL USE ONLY FOR 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
- Overrides:
parseElement
in classField
- 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.
-
validate
Check if the object is valid and returns the state and details of possible errors.- Specified by:
validate
in interfaceValidatable
- Returns:
- the current state, never null.
-