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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.TopNConditionFormulas
All Implemented Interfaces:
IClone

public class TopNConditionFormulas
extends java.lang.Object

This class stores a collection of condition formulas that override the sort values for the default Top N sort order of the TopNSort object.

See Also:
ITopNSort#getConditionFormulas}

Constructor Summary
TopNConditionFormulas()
          Creates a new, empty collection.
TopNConditionFormulas(TopNConditionFormulas src)
          Copies the specified TopNConditionFormulas collection.
 
Method Summary
 void clear()
          Removes all of the formulas.
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 int count()
           
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
           
 IDataConditionFormula get(java.lang.Object key)
           For internal use only.
 IDataConditionFormula getFormula(TopNConditionFormulaType type)
          Returns the specified condition formula.
 boolean hasContent(java.lang.Object objFormulas)
           
 void put(java.lang.Object key, IDataConditionFormula newFormula)
           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 remove(TopNConditionFormulaType type)
          Removes the specified condition formula from the collection.
 void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
           
 void save(XMLWriter writer, XMLSerializationContext ctxt)
           
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
           
 void setFormula(TopNConditionFormulaType type, IDataConditionFormula newFormula)
          Sets the specified condition formula.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TopNConditionFormulas

public TopNConditionFormulas(TopNConditionFormulas src)
Copies the specified TopNConditionFormulas collection. This method creates a deep copy of the src collection.

Parameters:
src - The collection to copy.

TopNConditionFormulas

public TopNConditionFormulas()
Creates a new, empty collection.

Method Detail

getFormula

public IDataConditionFormula getFormula(TopNConditionFormulaType type)

Returns the specified condition formula.

Parameters:
type - A TopNConditionFormulaType object containing a number that corresponds to the enumerator ID of the formula to be returned.
Returns:
A IDataConditionFormula object containing the specified condition formula.

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.


remove

public void remove(TopNConditionFormulaType type)

Removes the specified condition formula from the collection.

Parameters:
type - A TopNConditionFormulaType object containing a number that corresponds to the enumerator ID of the formula to be removed from the collection.

setFormula

public void setFormula(TopNConditionFormulaType type,
                       IDataConditionFormula newFormula)

Sets the specified condition formula.

The condition formula must be a constant numeric type. Other constant formula types and parameter fields can by used as operands. When the formula is evaluated, both the field value type and the value range are checked.

To stay within the value range, set the sort direction to the constant enumerator or the value that specifies ascending order, descending order, or the original order that the data was put into the database. Other values are invalid.

Parameters:
type - A TopNConditionFormulaType object containing a number that corresponds to the enumerator ID.
newFormula - A IDataConditionFormula object containing the new formula to be added to the collection.

clear

public void clear()

Removes all of the formulas.


clone

public java.lang.Object clone(boolean deepClone)

copyTo

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

count

public int count()

createMember

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

endElement

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

get

public IDataConditionFormula get(java.lang.Object key)

For internal use only.


hasContent

public boolean hasContent(java.lang.Object objFormulas)

put

public void put(java.lang.Object key,
                IDataConditionFormula newFormula)

For internal use only.


save

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

save

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

saveContents

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

startElement

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