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
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 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 doControllerModification(java.lang.Object newObject)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
           
 ControllableMixin getControllableMixin()
           
 SortDirection getDirection()
           Returns the direction in which the data is sorted.
 IField getSortField()
           Returns the field that is being sorted.
 boolean hasContent(java.lang.Object srcSort)
           
 boolean isDirectlyControllable()
           
 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 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)

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.

hasContent

public boolean hasContent(java.lang.Object srcSort)

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.

startElement

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

For internal use only.


getControllableMixin

public ControllableMixin getControllableMixin()

doControllerModification

public void doControllerModification(java.lang.Object newObject)
                              throws ReportSDKException
Throws:
ReportSDKException

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)