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

java.lang.Object
  extended by java.util.AbstractCollection
      extended by java.util.AbstractList
          extended by java.util.ArrayList
              extended by com.crystaldecisions.sdk.occa.report.lib.ClonableList
                  extended by com.crystaldecisions.sdk.occa.report.lib.ReportSDKVector
                      extended by com.crystaldecisions.sdk.occa.report.data.FilterItems
All Implemented Interfaces:
IClone, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess

public class FilterItems
extends ReportSDKVector
implements IClone

This object is used to contain a list of FieldRangeFilterItem and OperatorFilterItem objects that contain parsed information about a filter string. This collection is used primarily by the Filter object. It is basically the result of the filter's parsed formula string. If the filter cannot be parsed into filter items, this collection will be empty. That is, if the formula is too complex and cannot be parsed, the Filter object's getFilterItems method returns null and only the FreeEditingText property remains.

The following diagram illustrates the relationship between a formula string and the FilterItems collection.

Note: The collection stores an array of FilterItem objects. However, FilterItem is used as a base from which FieldRangeFilterItem and OperatorFilterItem inherit. When you access the collection array, it is one of these two objects that you will retrieve.

Additionally, be aware that when parentheses are used in expressions, each parenthesis accounts for one OperatorFilterItem.

See Also:
Serialized Form

Constructor Summary
FilterItems()
           
FilterItems(FilterItems src)
           
 
Method Summary
 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.
 IFilterItem getFilterItem(int index)
           Returns the IFilterItem at the specified index.
 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 startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
          For internal use only.
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.lib.ReportSDKVector
add, add, addElement, addNullElement, elementAt, insertElementAt, removeAllElements
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.lib.ClonableList
clone, copyTo, copyTo, findIndexOf, hasContent
 
Methods inherited from class java.util.ArrayList
addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, remove, set, size, toArray, toArray, trimToSize
 
Methods inherited from class java.util.AbstractList
equals, hashCode, iterator, listIterator, listIterator, subList
 
Methods inherited from class java.util.AbstractCollection
containsAll, removeAll, retainAll, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
containsAll, equals, hashCode, iterator, listIterator, listIterator, removeAll, retainAll, subList
 

Constructor Detail

FilterItems

public FilterItems(FilterItems src)

FilterItems

public FilterItems()
Method Detail

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)
Description copied from class: ClonableList
For internal use only.

Overrides:
createMember in class ClonableList

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)
Description copied from class: ClonableList
For internal use only.

Overrides:
endElement in class ClonableList

getFilterItem

public IFilterItem getFilterItem(int index)

Returns the IFilterItem at the specified index.

Parameters:
index - The index of the desired IFilterItem object.
Returns:
The IFilterItem at the specified index.

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)
Description copied from class: ClonableList
For internal use only.

Overrides:
readElement in class ClonableList

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Description copied from class: ClonableList
For internal use only.

Overrides:
save in class ClonableList
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Description copied from class: ClonableList
For internal use only.

Overrides:
save in class ClonableList
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
Description copied from class: ClonableList
For internal use only.

Overrides:
saveContents in class ClonableList
Throws:
java.io.IOException

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)
Description copied from class: ClonableList
For internal use only.

Overrides:
startElement in class ClonableList