Klasse SummaryField

java.lang.Object
com.inet.report.Field
com.inet.report.SummaryField
Alle implementierten Schnittstellen:
NodeParser, com.inet.report.ReferencedObject, com.inet.report.ReferenceHolder, Validatable, Serializable
public class SummaryField extends Field implements com.inet.report.ReferenceHolder, Validatable
A summary field summarizes data of other fields in the report. You can print out the summary with a FieldElement or a FieldPart. To create a new SummaryField use the method Fields.addSummaryField(Field, int, String) in class Fields and give the field which data should summarized and the kind of the summary using the constants.

This class is part of the RDC.
Siehe auch:

  • Felddetails

    • SUM

      public static final int SUM
      SummaryField calculates sum.
      Siehe auch:

    • AVERAGE

      public static final int AVERAGE
      SummaryField calculates average.
      Seit:
      6.0
      Siehe auch:

    • SAMPLE_VARIANCE

      public static final int SAMPLE_VARIANCE
      SummaryField calculates sample varianz.
      Seit:
      6.0
      Siehe auch:

    • SAMPLE_STANDARD_DEVIATION

      public static final int SAMPLE_STANDARD_DEVIATION
      SummaryField calculates sample standard deviation.
      Seit:
      6.0
      Siehe auch:

    • MAXIMUM

      public static final int MAXIMUM
      SummaryField calculates maximum.
      Seit:
      6.0
      Siehe auch:

    • MINIMUM

      public static final int MINIMUM
      SummaryField calculates minimum.
      Seit:
      6.0
      Siehe auch:

    • COUNT

      public static final int COUNT
      SummaryField calculates count.
      Seit:
      6.0
      Siehe auch:

    • POP_VARIANCE

      public static final int POP_VARIANCE
      SummaryField calculates population variance.
      Seit:
      6.0
      Siehe auch:

    • POP_STANDARD_DEVIATION

      public static final int POP_STANDARD_DEVIATION
      SummaryField calculates population standard deviation.
      Seit:
      6.0
      Siehe auch:

    • DISTINCT_COUNT

      public static final int DISTINCT_COUNT
      SummaryField calculates distinct count.
      Seit:
      6.0
      Siehe auch:

    • CORRELATION

      public static final int CORRELATION
      SummaryField calculates correlation.
      Seit:
      6.0
      Siehe auch:

    • COVARIANCE

      public static final int COVARIANCE
      SummaryField calculates covariance.
      Seit:
      6.0
      Siehe auch:

    • WEIGHTED_AVERAGE

      public static final int WEIGHTED_AVERAGE
      SummaryField calculates weigted average.
      Seit:
      6.0
      Siehe auch:

    • MEDIAN

      public static final int MEDIAN
      SummaryField calculates median.
      Seit:
      6.0
      Siehe auch:

    • PERCENTILE

      public static final int PERCENTILE
      SummaryField calculates percentile.
      Seit:
      6.0
      Siehe auch:

    • NTH_LARGEST

      public static final int NTH_LARGEST
      SummaryField calculates Nth lagest.
      Seit:
      6.0
      Siehe auch:

    • NTH_SMALLEST

      public static final int NTH_SMALLEST
      SummaryField calculates Nth smallest.
      Seit:
      6.0
      Siehe auch:

    • MODE

      public static final int MODE
      SummaryField calculates mode.
      Seit:
      6.0
      Siehe auch:

    • NTH_MOST_FREQUENT

      public static final int NTH_MOST_FREQUENT
      SummaryField calculates Nth most frequent.
      Seit:
      6.0
      Siehe auch:

    • PERCENTAGE

      public static final int PERCENTAGE
      SummaryField calculates percentage.
      Seit:
      6.0
      Siehe auch:

    • NO_SUMMARY_OPERATION

      public static final int NO_SUMMARY_OPERATION
      SummaryField calculates no operation, data will returned originally.
      Seit:
      6.0
      Siehe auch:

    • SUMMARY_REPORT

      public static final int SUMMARY_REPORT
      Indicates that this summary field belongs to the report object
      Siehe auch:

    • SUMMARY_CROSSTAB

      public static final int SUMMARY_CROSSTAB
      Indicates that this summary field belongs to the crosstab column object
      Siehe auch:

    • SUMMARY_CHART

      public static final int SUMMARY_CHART
      Indicates that this summary field belongs to the chart object
      Siehe auch:

    • defaultHolder

      protected com.inet.report.DefaultReferenceHolder defaultHolder
      contains referenced objects

  • Konstruktordetails

    • SummaryField

      protected SummaryField(com.inet.report.RendererBase ren)
      FOR INTERNAL USE ONLY

  • Methodendetails

    • setName

      public void setName(String name)
      Sets the name of the summary field. The name is a unique identifier of this field.
      Angegeben von:
      setName in Klasse Field
      Parameter:
      name - the name for this summary field.
      Löst aus:
      IllegalArgumentException - will thrown if the name already exists or if the name is null or empty.
      Seit:
      6.0

    • setSummaryOperation

      public final void setSummaryOperation(int operation)
      Sets the value of the property 'summary operation'.
      Parameter:
      operation - The new value of the property 'summary operation'.
      Seit:
      6.0
      Siehe auch:

    • getSummaryOperation

      public int getSummaryOperation()
      Returns the value of the property 'summary operation'.
      Gibt zurück:
      The current value of the property 'summary operation'.
      Seit:
      6.0
      Siehe auch:

    • getOperationName

      public static final String getOperationName(int operation)
      Returns the name of the operation by id.
      Parameter:
      operation - the value of the summary operation property.
      Gibt zurück:
      String The name of the summary operation
      Seit:
      6.0
      Siehe auch:

    • getSummaryOperation

      public static final int getSummaryOperation(String operation)
      Returns the operation constant according to the name
      Parameter:
      operation - Operation name
      Gibt zurück:
      operation constant
      Seit:
      8.1
      Siehe auch:

    • getSummaryFieldType

      public int getSummaryFieldType()
      Indicates to which object this summary field belongs.
      Gibt zurück:
      The summary type
      Seit:
      6.0
      Siehe auch:

    • setSummaryFieldType

      public void setSummaryFieldType(int type)
      Sets to which object this summary field belongs.
      Parameter:
      type - the type of parent element.
      Seit:
      6.0
      Siehe auch:

    • getResetField

      public Field getResetField()
      Running total is reset if this field value was changed.
      Gibt zurück:
      • null
      • a FormulaField
      • a DatabaseField
      • a GroupField
      Löst aus:
      IllegalStateException - will thrown if changeType is unknown.
      Seit:
      6.0

    • setResetField

      public void setResetField(Field rstField)
      Running total Field reset if this field value was changed.
      Parameter:
      rstField -
      • no field is needed, summary will reset on each record
      • resetField have to be an instance of FormulaField
      • resetField have to be an instance of DatabaseField
      • resetField have to be an instance of GroupField
      Löst aus:
      IllegalArgumentException - will thrown if rstField is a GroupField and does not match a group.
      Seit:
      6.0

    • getChangeField

      public Field getChangeField()
      Running total changes if this field value was changed.
      Gibt zurück:
      • null
      • a FormulaField
      • a DatabaseField
      • a GroupField
      Löst aus:
      IllegalStateException - will be thrown if changeType has unknown value;
      Seit:
      6.0
      Siehe auch:

    • setChangeField

      public void setChangeField(Field changeField)
      Running total changes if this field value was changed.
      Parameter:
      changeField -
      • no field is needed, summary will be changed on each record
      • changeField have to be an instance of FormulaField
      • changeField have to be an instance of DatabaseField
      • changeField have to be an instance of GroupField
      Löst aus:
      IllegalArgumentException - will be thrown if changeField is a GroupField and does not match a group.
      Seit:
      6.0
      Siehe auch:

    • getSummaryNth

      public int getSummaryNth()
      Returns the Nth value in Nth-functions.
      Gibt zurück:
      value of nth property.
      Seit:
      6.0

    • setSummaryNth

      public void setSummaryNth(int summaryNth)
      Sets the Nth value in Nth-functions.
      Following operations needs the 'nth' parameter:
      NTH_LARGEST
      NTH_SMALLEST
      NTH_MOST_FREQUENT
      PERCENTILE
      Parameter:
      summaryNth - value of nth property.
      Seit:
      6.0
      Siehe auch:

    • setShowPercentVal

      public void setShowPercentVal(boolean newValue)
      Sets how the result of summary operation is shown.
      Parameter:
      newValue - true when the value of this summary field is shown as percent value.
      Seit:
      6.0

    • getShowPercentVal

      public boolean getShowPercentVal()
      How result of summary operation is shown.
      Gibt zurück:
      true when the value of this summary field is shown as percent value.
      Seit:
      6.0

    • getRunningTotal

      public boolean getRunningTotal()
      Returns the running total property of this SummaryField. If it not the running total then it can have a group field, only. A running total SummaryField can change its value for each row. If it is not a running total Field then the value is identical for all rows in one group.
      Gibt zurück:
      true if this is a running total.
      Seit:
      6.0
      Siehe auch:

    • setRunningTotal

      public void setRunningTotal(boolean isRunningTotal)
      Sets the running total property of this SummaryField.
      Parameter:
      isRunningTotal - the value of the running total property.
      Seit:
      6.0
      Siehe auch:

    • 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.
      Setzt außer Kraft:
      getValueType in Klasse Field
      Gibt zurück:
      The value of the property 'value type'.
      Siehe auch:

    • paramString

      public String paramString()
      Returns a prettified output of this field's name and type.
      Setzt außer Kraft:
      paramString in Klasse Field
      Gibt zurück:
      Prettified output of this field's name and type.

    • generateName

      public static String generateName(String field, String group, int sumType)
      Generates the name of a summary field, i.e. "Count of OrderID".
      For summary functions like "Weighted Average" you can use the method generateName with 4 parameters.
      Parameter:
      field - - name of the field with values to summarizes
      group - - name of the field the values are grouped by
      sumType - - the type of summary function
      Gibt zurück:
      String - the generated name
      Seit:
      6.0
      Siehe auch:

    • generateName

      public static String generateName(String field, String group, int sumType, String field2)
      Generates the name of a summary field, i.e. "Count of OrderID, CustomerID".
      Use this method for summary functions like "Weighted Average" or "Correlation" etc.
      Parameter:
      field - - name of the field with numeric values to summarizes
      group - - name of the field that contains the values are grouped by
      sumType - - the type of summary function
      field2 - - name of the second field, e.g. for Weighted Average
      Gibt zurück:
      String - the generated name
      Seit:
      6.0
      Siehe auch:

    • getField2nd

      public Field getField2nd()
      Some Summaries need two fields for calculation, i.e. weighted average, correlation etc. Returns the 2nd field used for weights in weighted average, correlation between the field returned by getField() and the field returned by this function.
      Gibt zurück:
      Field
      Seit:
      6.0

    • setField2nd

      public void setField2nd(Field field2nd)
      Sets the second field. The second field is used as weights in weighted average or as correlation between the field and second field. Only Field.CURRENCY and Field.NUMBER are as value type of this field supported.
      Following summary operations needs first and second fields for calculation:
      CORRELATION
      COVARIANCE
      WEIGHTED_AVERAGE
      All others ignore this property.
      Parameter:
      field2nd - the second field.
      Seit:
      6.0
      Siehe auch:

    • changeAliasName

      public void changeAliasName(String oldAlias, String newAlias)
      FOR INTERNAL USE ONLY

    • 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

    • 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
      Seit:
      6.0

    • setReferences

      public void setReferences()
      FOR INTERNAL USE ONLY
      Angegeben von:
      setReferences in Schnittstelle com.inet.report.ReferenceHolder

    • resetReferences

      public void resetReferences()
      FOR INTERNAL USE ONLY
      Angegeben von:
      resetReferences in Schnittstelle com.inet.report.ReferenceHolder

    • setField

      public void setField(Field newField)
      Sets the field witch values will be used by result calculating of this summary field.
      Note: some summary operations supports only specific value type of field.
      Following operations supports all value types:
      MAXIMUM
      MINIMUM
      MODE
      NTH_LARGEST
      NTH_MOST_FREQUENT
      NTH_SMALLEST
      COUNT
      DISTINCT_COUNT

      Following operations supports only Field.CURRENCY and Field.NUMBER as value type:
      AVERAGE
      SUM
      MEDIAN
      PERCENTILE
      POP_STANDARD_DEVIATION
      POP_VARIANCE
      SAMPLE_STANDARD_DEVIATION
      SAMPLE_VARIANCE
      CORRELATION
      COVARIANCE
      WEIGHTED_AVERAGE
      Setzt außer Kraft:
      setField in Klasse Field
      Parameter:
      newField - the base field for this summary operation.
      Seit:
      6.0
      Siehe auch:

    • setGroup

      public void setGroup(Group group)
      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.
      Setzt außer Kraft:
      setGroup in Klasse Field
      Parameter:
      group - The reference to the group of this field.
      Siehe auch:

    • equals

      public boolean equals(Object obj)
      Indicates whether some other SummaryField is "equal to" this one.
      Setzt außer Kraft:
      equals in Klasse Field
      Parameter:
      obj - Object to compare
      Gibt zurück:
      true if this SummaryField is the same as the SummaryField argument; false otherwise.
      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.

    • saveFieldXML2

      protected void saveFieldXML2(PrintWriter pw, int depth)
      Saves SummaryField attributes
      Angegeben von:
      saveFieldXML2 in Klasse Field
      Parameter:
      pw - the printwriter.
      depth - the current depth.
      Seit:
      8.1

    • duplicate

      public Field duplicate(String name)
      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:
      name - the name the created field should have.
      Gibt zurück:
      the duplicated field.

    • 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.

    • isInternalField

      public boolean isInternalField()
      FOR INTERNAL USE ONLY Returns whether this is an internal (not editable) summary field
      Gibt zurück:
      whether this is an internal (not editable) summary field