Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.selection
Class SortSpec

oracle.dss.selection.SortSpec

public class SortSpec

Defines the Sorting specification for a selection, as a set of ConditonSortSteps and MemberSortSteps.

See Also:
Serialized Form

Constructor Summary
SortSpec()
          Constructor

 

Method Summary
 void addConditionSortStep(ConditionSortStep step)
          Adds the given ConditionSortStep to the Sort specification.
 void addMemberSortStep(MemberSortStep step)
          Adds the given MemberSortStep to the Sort specification.
 java.lang.Object clone()
          Implement Cloneable interface
 boolean equals(java.lang.Object obj)
          Tests this SortSpec for true equality
 ConditionSortStep getConditionSortStepAt(int pos)
          Retrieves a ConditionSortStep from the given position in the Sort specification.
 int getConditionSortStepCount()
          Retrieves the number of the Condition Sort Steps from the Sort specification.
 int getConditionSortStepPos(ConditionSortStep step)
          Retrieves the position of the given ConditionSortStep in the Sort specification.
 ConditionSortStep getHierarchicalSortStep()
          Retrieves the hierarchical ConditionSortStep in the Sort specification.
 MemberSortStep getMemberSortStepAt(int pos)
          Retrieves a MemberSortStep from the given position in the Sort specification.
 int getMemberSortStepCount()
          Retrieves the number of the Member Sort Steps from the Sort specification.
 int getMemberSortStepPos(MemberSortStep step)
          Retrieves the position of the given MemberSortStep in the Sort specification.
 java.lang.String getTagName()
          Retrieves the name used for persisting the SortSpec in XML
 java.lang.Object getXML( controls)
          Returns the Sort Specification representation in XML in context of the Persistence framework
 void insertConditionSortStepAt(ConditionSortStep step, int pos)
          Inserts the given ConditionSortStep into the Sort specification.
 void insertMemberSortStepAt(MemberSortStep step, int pos)
          Inserts the given MemberSortStep into the Sort specification.
 void removeAllConditionSortSteps()
          Removes all the ConditionSortSteps from the Sort specification.
 void removeAllMemberSortSteps()
          Removes all the MemberSortSteps from the Sort specification.
 boolean removeConditionSortStep(ConditionSortStep step)
          Removes the given ConditionSortStep from the Sort specification.
 boolean removeMemberSortStep(MemberSortStep step)
          Removes the given MemberSortStep from the Sort specification.
 void setHierarchicalSortStep(ConditionSortStep step)
          Adds the given hierarchical ConditionSortStep to the Sort specification.
 void setXML( context, java.lang.Object node)
          Restores the Sort Specification data from the given persistence object tree

 

Constructor Detail

SortSpec

public SortSpec()
Constructor
Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Implement Cloneable interface
Throws:
java.lang.CloneNotSupportedException -  

equals

public boolean equals(java.lang.Object obj)
Tests this SortSpec for true equality
Overrides:
equals in class java.lang.Object
Parameters:
obj - SortSpec to compare it to
Returns:
true if completely internally equal

getConditionSortStepCount

public int getConditionSortStepCount()
Retrieves the number of the Condition Sort Steps from the Sort specification.
Returns:
the number of the Condition Sort Steps

getConditionSortStepAt

public ConditionSortStep getConditionSortStepAt(int pos)
Retrieves a ConditionSortStep from the given position in the Sort specification.
Parameters:
position - from which the Step is to be retrieved
Returns:
ConditionSortStep object from the specified index

getConditionSortStepPos

public int getConditionSortStepPos(ConditionSortStep step)
Retrieves the position of the given ConditionSortStep in the Sort specification.
Parameters:
ConditionSortStep - for which the index should be retrieved
Returns:
position of the given ConditionSortStep in the SortSpec, -1 if the step was not found

getHierarchicalSortStep

public ConditionSortStep getHierarchicalSortStep()
Retrieves the hierarchical ConditionSortStep in the Sort specification.
Returns:
the hierarchical ConditionSortStep in the SortSpec

setHierarchicalSortStep

public void setHierarchicalSortStep(ConditionSortStep step)
Adds the given hierarchical ConditionSortStep to the Sort specification.
Parameters:
ConditionSortStep - object to be added to the SortSpec

addConditionSortStep

public void addConditionSortStep(ConditionSortStep step)
Adds the given ConditionSortStep to the Sort specification.
Parameters:
ConditionSortStep - object to be added to the SortSpec

insertConditionSortStepAt

public void insertConditionSortStepAt(ConditionSortStep step,
                                      int pos)
Inserts the given ConditionSortStep into the Sort specification.
Parameters:
ConditionSortStep - object to be added to the ConditionSortStep collection in the SortSpec
pos - position where the step should be inserted

removeConditionSortStep

public boolean removeConditionSortStep(ConditionSortStep step)
Removes the given ConditionSortStep from the Sort specification.
Parameters:
ConditionSortStep - object to be removed from the ConditionSortStep collection in the SortSpec
Returns:
true if the argument was in the SortSpec; false otherwise.

removeAllConditionSortSteps

public void removeAllConditionSortSteps()
Removes all the ConditionSortSteps from the Sort specification.

getMemberSortStepCount

public int getMemberSortStepCount()
Retrieves the number of the Member Sort Steps from the Sort specification.
Returns:
the number of the Member Sort Steps

getMemberSortStepAt

public MemberSortStep getMemberSortStepAt(int pos)
Retrieves a MemberSortStep from the given position in the Sort specification.
Parameters:
position - from which the Step is to be retrieved
Returns:
MemberSortStep object from the specified index

getMemberSortStepPos

public int getMemberSortStepPos(MemberSortStep step)
Retrieves the position of the given MemberSortStep in the Sort specification.
Parameters:
MemberSortStep - for which the index should be retrieved
Returns:
position of the given MemberSortStep in the SortSpec, -1 if the step was not found

addMemberSortStep

public void addMemberSortStep(MemberSortStep step)
Adds the given MemberSortStep to the Sort specification.
Parameters:
MemberSortStep - object to be added to the SortSpec

insertMemberSortStepAt

public void insertMemberSortStepAt(MemberSortStep step,
                                   int pos)
Inserts the given MemberSortStep into the Sort specification.
Parameters:
MemberSortStep - object to be added to the MemberSortStep collection in the SortSpec
pos - position where the step should be inserted

removeMemberSortStep

public boolean removeMemberSortStep(MemberSortStep step)
Removes the given MemberSortStep from the Sort specification.
Parameters:
MemberSortStep - object to be removed from the MemberSortStep collection in the SortSpec
Returns:
true if the argument was in the SortSpec; false otherwise.

removeAllMemberSortSteps

public void removeAllMemberSortSteps()
Removes all the MemberSortSteps from the Sort specification.

getXML

public java.lang.Object getXML( controls)
Returns the Sort Specification representation in XML in context of the Persistence framework
Returns:
the root ObjectNode of the persistence object tree

setXML

public void setXML( context,
                   java.lang.Object node)
Restores the Sort Specification data from the given persistence object tree
Parameters:
the - root ObjectNode of the persistence object tree

getTagName

public java.lang.String getTagName()
Retrieves the name used for persisting the SortSpec in XML
Returns:
String name

Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


Copyright © 2003, Oracle. All Rights Reserved.