Klasse SortField

java.lang.Object
com.inet.report.Field
com.inet.report.SortField
Alle implementierten Schnittstellen:
NodeParser, com.inet.report.ReferencedObject, com.inet.report.ReferenceHolder, Validatable, Serializable
public class SortField extends Field implements com.inet.report.ReferenceHolder, Validatable
With this field you can only set the sorting of the report data. This field can not be displayed with a FieldElement.

This class is part of the RDC.
Siehe auch:

  • Felddetails

    • ASCENDING_ORDER

      public static final int ASCENDING_ORDER
      Sort records ascending.
      Siehe auch:

    • DESCENDING_ORDER

      public static final int DESCENDING_ORDER
      Sort records descending.
      Siehe auch:

    • ORIGINAL_ORDER

      public static final int ORIGINAL_ORDER
      Do not sort records, let it unsorted.
      Siehe auch:

    • ASCENDING_ALPHA_NUMERIC_ORDER

      public static final int ASCENDING_ALPHA_NUMERIC_ORDER
      Sort records ascending.
      Siehe auch:

    • DESCENDING_ALPHA_NUMERIC_ORDER

      public static final int DESCENDING_ALPHA_NUMERIC_ORDER
      Sort records descending.
      Siehe auch:

  • Methodendetails

    • setName

      public void setName(String name) throws ReportException
      Sets the name of the sort field. The name must be the name of the database field, which should be the sort criterion. The name of the field should start with a special character for instanciation:
      • no charcter, if the field is a database field
      • 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
      This is different to the naming of a field, where you do not concatenate the character, because you give the field only a name. Here you want to instanciate an existing field with its name.
      Angegeben von:
      setName in Klasse Field
      Parameter:
      name - The name of the sort field for example, Users.UserID
      Löst aus:
      ReportException - if no database field with this name exists
      IllegalArgumentException - if a sort field with name equals name already exists
      Seit:
      6.0

    • setSort

      public void setSort(int sort)
      Sets the value of the property 'sort direction'. The sort direction determines the order of the fetched data in the presented list. It can be ascending, descending or original order.
      Parameter:
      sort - The new value of the property 'sort direction'.
      Löst aus:
      IllegalArgumentException - on illegal sort direction values
      Seit:
      6.0
      Siehe auch:

    • getSort

      public int getSort()
      Returns the value of the property 'sort direction'.
      Gibt zurück:
      The current value of the property 'sort direction'.
      Seit:
      6.0
      Siehe auch:

    • setSortDirectionFormula

      public void setSortDirectionFormula(FormulaField formula) throws ReportException
      Sets the formula of sort direction. This formula must be of type FormulaField.FORMULA_PROPERTY and must return a positive int value. Allowed range of values 0 for ASCENDING_ORDER, 1 for DESCENDING_ORDER, 2 for ORIGINAL_ORDER (data stays unsorted). Other formula will be ignored.
      Parameter:
      formula - for sort direction or null to remove the sort direction formula.
      Löst aus:
      ReportException - Wrong formula, formula type or return value of formula
      Seit:
      6.0

    • getSortDirectionFormula

      public FormulaField getSortDirectionFormula()
      Returns the formula of sort direction for this sort field.
      Gibt zurück:
      sort direction formula
      Seit:
      6.0
      Siehe auch:

    • saveFieldXML2

      protected void saveFieldXML2(PrintWriter pw, int depth)
      XML2: 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
      Parameter:
      reference - a new referenced object
      Seit:
      6.0

    • getReferencedObjects

      public final com.inet.report.ReferencedObject[] getReferencedObjects()
      FOR INTERNAL USE ONLY
      Angegeben von:
      getReferencedObjects in Schnittstelle com.inet.report.ReferenceHolder
      Gibt zurück:
      the referenced objects

    • getRealReferencedObjectCount

      public final int getRealReferencedObjectCount()
      FOR INTERNAL USE ONLY
      Angegeben von:
      getRealReferencedObjectCount in Schnittstelle com.inet.report.ReferenceHolder
      Gibt zurück:
      the count of real referenced objects
      Seit:
      6.0

    • getReferencedObjectCount

      public final int getReferencedObjectCount()
      FOR INTERNAL USE ONLY
      Angegeben von:
      getReferencedObjectCount in Schnittstelle com.inet.report.ReferenceHolder
      Gibt zurück:
      the count of referenced objects

    • removeReferencedObject

      public final void removeReferencedObject(com.inet.report.ReferencedObject reference)
      FOR INTERNAL USE ONLY
      Angegeben von:
      removeReferencedObject in Schnittstelle com.inet.report.ReferenceHolder
      Parameter:
      reference - the object
      Seit:
      6.0

    • 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
      Gibt zurück:
      is always used
      Seit:
      6.0

    • equals

      public boolean equals(Object obj)
      Indicates whether some other SortField is "equal to" this one.
      Setzt außer Kraft:
      equals in Klasse Field
      Parameter:
      obj - the reference SortField with which to compare.
      Gibt zurück:
      true if this SortField is the same as the SortField argument; false otherwise.
      Seit:
      6.0

    • getValueType

      public int getValueType()
      Returns the value type (or return type) of the field.
      Setzt außer Kraft:
      getValueType in Klasse Field
      Gibt zurück:
      The value of the property 'value type'. Will be Field.UNKNOWN if the current value of the 'field' property is not set. Use validate() to check this.
      Seit:
      6.1
      Siehe auch:

    • updateName

      public void updateName()
      Updates the field's ref name. Note that this method simply updates the name of this SortField by calling {FieldField.getRefName().
      Seit:
      7.0
      Siehe auch:

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

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