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

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.lib.ReportSDKVectorInternal
                          extended by com.crystaldecisions.sdk.occa.report.data.Fields
All Implemented Interfaces:
IClone, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess
Direct Known Subclasses:
SummaryFields

public class Fields
extends ReportSDKVectorInternal
implements IClone

This object stores an array of fields. The fields may be one of the following types:

See Also:
Serialized Form

Constructor Summary
Fields()
           
Fields(Fields 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.
 int find(java.lang.String fieldName, FieldDisplayNameType displayType, java.util.Locale locale)
           Searches for a field with a particular name and returns its index.
 IField findField(java.lang.String fieldName, FieldDisplayNameType displayType, java.util.Locale locale)
           Searches for a field with a particular name in the Fields collection and returns a reference to the field.
 IField getField(int index)
           Returns the field at the specified index.
 boolean isOwner(AncestorLink listAncestor, java.lang.Object element)
          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 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.ReportSDKVectorInternal
add, add, addAll, addAll, addElement, addEventListener, clear, remove, remove, removeAll, removeAllElements, retainAll, set
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.lib.ReportSDKVector
addNullElement, elementAt, insertElementAt
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.lib.ClonableList
clone, copyTo, copyTo, findIndexOf, hasContent
 
Methods inherited from class java.util.ArrayList
clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, 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, 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, subList
 

Constructor Detail

Fields

public Fields(Fields src)

Fields

public Fields()
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

find

public int find(java.lang.String fieldName,
                FieldDisplayNameType displayType,
                java.util.Locale locale)

Searches for a field with a particular name and returns its index. If the item is not found, -1 is returned. The field's display name is used in the search.

Parameters:
fieldName - The name of field you want to find.
displayType - Indicates the form in which fieldName appears. It may be one of the values in FieldDisplayNameType.
locale - The locale of the field.
Returns:
The index of the field with the specified name.

findField

public IField findField(java.lang.String fieldName,
                        FieldDisplayNameType displayType,
                        java.util.Locale locale)

Searches for a field with a particular name in the Fields collection and returns a reference to the field.

Example:

This sample shows how to search the Fields collection for a field with a specific display name and to return its index. The display name property specifies how the name of the field has been formatted. The FieldDisplayNameType provides the different ways a display name can be formatted.

 DatabaseController databaseController = clientDoc.getDatabaseController();
 IDatabase database = databaseController.getDatabase();
 Tables tables = database.getTables();
 ITable table = (Table)tables.getTable(0);
 Fields fields = table.getDataFields();
 IField field = (Field)fields.findField("{Customer.Region}", FieldDisplayNameType.fieldName, java.util.Locale.CANADA);
 

Parameters:
fieldName - the name of the field you want to find
displayType - the form in which the fieldName appears as defined by FieldDisplayNameType.
locale - the locale of the field as defined by Locale.
Returns:
IField a reference to the IField object
See Also:
FieldDisplayNameType

getField

public IField getField(int index)

Returns the field at the specified index.

Parameters:
index - The index of the desired field.
Returns:
The IField object 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

isOwner

public boolean isOwner(AncestorLink listAncestor,
                       java.lang.Object element)
Description copied from class: ClonableList
For internal use only.