com.iplanet.jato.model.sql
Class QueryFieldSchema

java.lang.Object
  |
  +--com.iplanet.jato.model.sql.QueryFieldSchema
All Implemented Interfaces:
java.io.Serializable

public class QueryFieldSchema
extends java.lang.Object
implements java.io.Serializable

The schema containing the SQL program metadata. The schema consists of a collection of QueryFieldDescriptor objects. The QueryModelBase implementation uses this metadata to prepare the SQL program and access the result set.

Version:
JATO/1.2.2 $Id: QueryFieldSchema.java,v 1.7 2002/03/16 03:26:33 todd Exp $
See Also:
QueryModel, QueryModelBase, QueryFieldDescriptor, Serialized Form

Constructor Summary
QueryFieldSchema()
          Default constructor.
 
Method Summary
 void addFieldDescriptor(QueryFieldDescriptor descriptor)
          Adds a QueryFieldDescriptor to the schema.
 QueryFieldDescriptor getFieldDescriptor(int index)
          Returns the QueryFieldDescriptor at the supplied index from the internal descriptor array.
 QueryFieldDescriptor getFieldDescriptor(java.lang.String name)
          Returns the QueryFieldDescriptor for a specific field name.
 QueryFieldDescriptor[] getFieldDescriptors()
          Returns the array of QueryFieldDescriptor objects.
 int getNumFields()
          Returns the total number of QueryFieldDescriptor objects in the schema.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

QueryFieldSchema

public QueryFieldSchema()
Default constructor.
Method Detail

getNumFields

public int getNumFields()
Returns the total number of QueryFieldDescriptor objects in the schema.

getFieldDescriptors

public QueryFieldDescriptor[] getFieldDescriptors()
Returns the array of QueryFieldDescriptor objects.

addFieldDescriptor

public void addFieldDescriptor(QueryFieldDescriptor descriptor)
Adds a QueryFieldDescriptor to the schema.
Parameters:
descriptor - A QueryFieldDescriptor which describes a particular data field.

getFieldDescriptor

public QueryFieldDescriptor getFieldDescriptor(int index)
Returns the QueryFieldDescriptor at the supplied index from the internal descriptor array.

getFieldDescriptor

public QueryFieldDescriptor getFieldDescriptor(java.lang.String name)
Returns the QueryFieldDescriptor for a specific field name. The name value should correspond to that returned by QueryFieldDescriptor.getName().