com.crystaldecisions.sdk.occa.report.data
Class Fields<E extends IField>

java.lang.Object
  extended by 
      extended by com.crystaldecisions.sdk.occa.report.data.Fields<E>
All Implemented Interfaces:
IClone
Direct Known Subclasses:
SummaryFields

public class Fields<E extends IField>
extends
implements IClone

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


Constructor Summary
Fields()
           
Fields(Fields<E> src)
           
 
Method Summary
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, com.crystaldecisions.xml.serialization.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 isDirectlyControllable()
           
 boolean isOwner(java.lang.Object element)
           
 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(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
           For internal use only.
 void save(com.crystaldecisions.xml.serialization.XMLWriter writer, java.lang.String sTag, com.crystaldecisions.xml.serialization.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 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Fields

public Fields(Fields<E> src)

Fields

public Fields()
Method Detail

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     com.crystaldecisions.xml.serialization.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.


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)

For internal use only.


save

public void save(com.crystaldecisions.xml.serialization.XMLWriter writer,
                 com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

public void save(com.crystaldecisions.xml.serialization.XMLWriter writer,
                 java.lang.String sTag,
                 com.crystaldecisions.xml.serialization.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

startElement

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

For internal use only.


isDirectlyControllable

public boolean isDirectlyControllable()

isOwner

public boolean isOwner(java.lang.Object element)