Klasse BySummaryOrder

java.lang.Object
com.inet.report.BySummaryOrder
Alle implementierten Schnittstellen:
NodeParser, Serializable
public class BySummaryOrder extends Object implements Serializable, NodeParser
BySummaryOrder saves the options for the sort by aggregate function.
Seit:
4.0
Siehe auch:

  • Felddetails

    • DEFAULT_OTHER_NAME

      public static final String DEFAULT_OTHER_NAME
      Default name for all other elements.
      Siehe auch:

    • GROUP_SORT_ALL

      public static final int GROUP_SORT_ALL
      Display all elements sorted ascending or descending
      Siehe auch:

    • GROUP_SORT_TOP_N

      public static final int GROUP_SORT_TOP_N
      Display only first n elements in descending sort order
      Siehe auch:

    • GROUP_SORT_BOTTOM_N

      public static final int GROUP_SORT_BOTTOM_N
      Display only first n elements in ascending sort order
      Siehe auch:

    • GROUP_SORT_TOP_N_PERCENTAGE

      public static final int GROUP_SORT_TOP_N_PERCENTAGE
      Display only first n-procent elements in descending sort order
      Siehe auch:

    • GROUP_SORT_BOTTOM_N_PERCENTAGE

      public static final int GROUP_SORT_BOTTOM_N_PERCENTAGE
      Display only first n-procent elements in ascending sort order
      Siehe auch:

    • SORT_ASCENDING_ORDER

      public static final int SORT_ASCENDING_ORDER
      Constant for ascending order sort direction.
      Siehe auch:

    • SORT_DESCENDING_ORDER

      public static final int SORT_DESCENDING_ORDER
      Constant for descending order sort direction.
      Siehe auch:

    • OTHER_RECORDS_GROUP_TO_OTHERS

      public static final int OTHER_RECORDS_GROUP_TO_OTHERS
      All values with sorting number greater than n are group together to the group other.
      Siehe auch:

    • OTHER_RECORDS_DISCARD

      public static final int OTHER_RECORDS_DISCARD
      All values with sorting number greater than n are discard and not part of the report.
      Siehe auch:

  • Konstruktordetails

    • BySummaryOrder

      public BySummaryOrder()
      FOR INTERNAL USE ONLY

  • Methodendetails

    • setSortType

      public void setSortType(int type)
      Sets the type of sorting
      Parameter:
      type - the type of sorting by summary.
      Seit:
      4.0
      Siehe auch:

    • getSortType

      public int getSortType()
      Gets the type of sorting
      Gibt zurück:
      type of sort
      Seit:
      4.0
      Siehe auch:

    • getOtherName

      public String getOtherName()
      Gets the display name the other group entry.
      Gibt zurück:
      the name for all other group values.
      Seit:
      4.0
      Siehe auch:

    • setN

      public void setN(int n)
      Sets the count of displayed elements
      Parameter:
      n - count of shown group values.
      Löst aus:
      IllegalArgumentException - if n less than 0.
      Seit:
      4.0

    • getN

      public int getN()
      Gets the count of displayed elements
      Gibt zurück:
      count
      Seit:
      4.0

    • setOtherName

      public void setOtherName(String otherName)
      Sets display name for the other group entry. This value has no effect if the sortType GROUP_SORT_ALL is set.
      Parameter:
      otherName - the new name.
      Löst aus:
      IllegalArgumentException - if the name is empty or null.
      Seit:
      4.0
      Siehe auch:

    • getOther

      public int getOther()
      Gets the type for handling the values with sorting number greater than n.
      Gibt zurück:
      the type of handling for all other group values.
      Seit:
      4.0
      Siehe auch:

    • setOther

      public void setOther(int otherType)
      Sets the type for handling the values with sorting number greater than n. This value has no effect if the sortType GROUP_SORT_ALL is set.
      Parameter:
      otherType - the new value.
      Seit:
      4.0
      Siehe auch:

    • getSummaryField

      public SummaryField getSummaryField(int index)
      Gets the summary field used for sorting at index position.
      Parameter:
      index - of the summary field.
      Gibt zurück:
      the summary field at index.
      Löst aus:
      IndexOutOfBoundsException - if this index is out of bounds of the summary fields list.
      Seit:
      4.0

    • getSummaryFieldCount

      public int getSummaryFieldCount()
      Use this method to get the number of summary fields used for sorting.
      Gibt zurück:
      The number of summary fields used for sorting.
      Seit:
      4.0

    • addSummaryField

      public void addSummaryField(SummaryField sField)
      Adds a summary field used for sorting.
      Parameter:
      sField - SummaryField
      Löst aus:
      IllegalArgumentException - if the SummaryField null is
      Seit:
      4.0

    • removeSummaryField

      public void removeSummaryField(int index)
      Removes the SummaryField from this sort order.
      Parameter:
      index - of removed field.
      Löst aus:
      IndexOutOfBoundsException - if this index is out of bounds of the summary fields list or the list is null.
      Seit:
      4.0

    • getSortDirection

      public int getSortDirection()
      Gets the direction of the sorting
      Gibt zurück:
      direction of sort
      Seit:
      4.0
      Siehe auch:

    • setSortDirection

      public void setSortDirection(int direction)
      Sets the direction of sorting
      Parameter:
      direction - the sort direction of this sort order, asc. or desc.
      Seit:
      4.0
      Siehe auch:

    • paramString

      public String paramString()
      Returns the String representation of this object.
      Gibt zurück:
      the description as String.
      Seit:
      6.0

    • equals

      public boolean equals(Object object)
      Compares the other object with this. Indicates whether some other object is "equal to" this one.
      Setzt außer Kraft:
      equals in Klasse Object
      Parameter:
      object - the other object
      Gibt zurück:
      true if this is equal to other object
      Seit:
      8.0

    • parseElement

      public NodeParser parseElement(com.inet.report.parser.XMLTag xGroup, String tag, Attributes atts, Map<String,Object> parserMap) throws FatalParserException
      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
      Parameter:
      xGroup - 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 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
      Parameter:
      text - text encountered and to be stored
      parserMap - The map of current Parser.

    • parseEndElement

      public void parseEndElement(com.inet.report.parser.XMLTag xGroup, String tag, Map<String,Object> parserMap) throws FatalParserException
      FOR INTERNAL USE ONLY Internal method for reading report XML

      Receive notification of the end of an XML tag.

      Angegeben von:
      parseEndElement in Schnittstelle NodeParser
      Parameter:
      xGroup - XMLTag of the current node to be parsed, or null if there is no such current group.
      tag - The XMLTag to be parsed
      parserMap - The map of current Parser.
      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.

    • isDOMParser

      public boolean isDOMParser()
      FOR INTERNAL USE ONLY Internal method for reading report XML

      Returns whether this node is to be read via a DOM parser.

      Angegeben von:
      isDOMParser in Schnittstelle NodeParser
      Gibt zurück:
      true if this node is to be read via a DOM parser, false otherwise.

    • parseDOM

      public void parseDOM(Node node, Map<String,Object> parserMap) throws FatalParserException
      FOR INTERNAL USE ONLY Internal method for reading report XML

      Parses the node.

      Angegeben von:
      parseDOM in Schnittstelle NodeParser
      Parameter:
      node - the node
      parserMap - The map of current Parser.
      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.

    • copy

      public BySummaryOrder copy()
      Creates a copy of this. The copy has then same group, renderer and sum fields.
      Gibt zurück:
      the copy
      Seit:
      11.1