com.crystaldecisions.sdk.occa.report.data
Class Sort

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.Sort
All Implemented Interfaces:
ISort, IClone
Direct Known Subclasses:
TopNSort

public class Sort
extends java.lang.Object
implements ISort, IClone

This object is used to indicate how data is sorted. It indicates which data is being sorted and the direction in which this data is sorted. When possible, use the ISort interface to manipulate this object.


Constructor Summary
Sort()
           
Sort(ISort src)
           
 
Method Summary
 void addInteractiveControlObjectName(java.lang.String iControlObjName)
          For internal use only
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy, AncestorLink sortAncestor)
           
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
           For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 SortDirection getDirection()
           Returns the direction in which the data is sorted.
 int getInteractiveControlObjectIndex(java.lang.String objectName)
          For internal use only
 java.util.List getInteractiveControlObjectNames()
          For internal use only
 IField getSortField()
           Returns the field that is being sorted.
 boolean hasContent(java.lang.Object srcSort)
           
 boolean hasContent(java.lang.Object srcSort, boolean bCheckIControlObjName)
          For internal use only
 boolean isInteractive()
          For internal use only
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
           For internal use only.
 void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
           For internal use only.
 void save(XMLWriter writer, XMLSerializationContext ctxt)
           For internal use only.
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
           For internal use only.
 void setDirection(SortDirection direction)
           Sets the direction in which the data is sorted.
 void setInteractiveControlObjectNames(java.util.List iControlObjNames)
          For internal use only
 void setSortField(IField sortField)
           Sets the field that is being sorted.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
           For internal use only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Sort

public Sort(ISort src)

Sort

public Sort()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy,
                   AncestorLink sortAncestor)

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)

For internal use only.


endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

For internal use only.


getDirection

public SortDirection getDirection()
Description copied from interface: ISort

Returns the direction in which the data is sorted.

Specified by:
getDirection in interface ISort
Returns:
A SortDirection object that specifies the direction in which that data is sorted.

getSortField

public IField getSortField()
Description copied from interface: ISort

Returns the field that is being sorted.

Specified by:
getSortField in interface ISort
Returns:
An IField object containing the field that is being sorted.

getInteractiveControlObjectNames

public java.util.List getInteractiveControlObjectNames()
Description copied from interface: ISort
For internal use only

Specified by:
getInteractiveControlObjectNames in interface ISort

isInteractive

public boolean isInteractive()
Description copied from interface: ISort
For internal use only

Specified by:
isInteractive in interface ISort

getInteractiveControlObjectIndex

public int getInteractiveControlObjectIndex(java.lang.String objectName)
Description copied from interface: ISort
For internal use only

Specified by:
getInteractiveControlObjectIndex in interface ISort

hasContent

public boolean hasContent(java.lang.Object srcSort)

hasContent

public boolean hasContent(java.lang.Object srcSort,
                          boolean bCheckIControlObjName)
For internal use only


readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

For internal use only.


save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

setDirection

public void setDirection(SortDirection direction)
Description copied from interface: ISort

Sets the direction in which the data is sorted.

Specified by:
setDirection in interface ISort
Parameters:
direction - A SortDirection object that specifies the direction in which that data is sorted.

setSortField

public void setSortField(IField sortField)
Description copied from interface: ISort

Sets the field that is being sorted.

Specified by:
setSortField in interface ISort
Parameters:
sortField - An IField object containing the field that is being sorted.

addInteractiveControlObjectName

public void addInteractiveControlObjectName(java.lang.String iControlObjName)
Description copied from interface: ISort
For internal use only

Specified by:
addInteractiveControlObjectName in interface ISort

setInteractiveControlObjectNames

public void setInteractiveControlObjectNames(java.util.List iControlObjNames)
Description copied from interface: ISort
For internal use only

Specified by:
setInteractiveControlObjectNames in interface ISort

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)

For internal use only.