|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The VWTableDefinition class provides the definition for database tables. Tables are used for queues, rosters, and logs
Method Summary | |
VWExposedFieldDefinition |
createFieldDefinition(java.lang.String theName,
int theType,
int theLength)
Creates an exposed field by passing in a field name and the type. |
VWIndexDefinition |
createIndexDefinition(java.lang.String theName,
java.lang.String[] theFieldNames)
Creates an index definition for this queue. |
void |
deleteFieldDefinition(java.lang.String theName)
Provides the ability to delete exposed fields from the queue. |
void |
deleteIndexDefinition(java.lang.String theName)
Provides the ability to delete indexes from this queue. |
java.lang.String |
getDescription()
Provides the description for this table definition. |
VWExposedFieldDefinition[] |
getFields()
Provides an array of exposed field definitions for this queue definition. |
VWIndexDefinition[] |
getIndexes()
Provides an array of index definitions for this queue definition |
java.lang.String |
getName()
Provides the name of the queue. |
void |
setDescription(java.lang.String theDescription)
Sets the description for this table definition |
java.lang.String |
toString()
Provides a string version of the table definition. |
Method Detail |
public VWExposedFieldDefinition createFieldDefinition(java.lang.String theName, int theType, int theLength) throws VWException
theName
- the name of the field.theType
- the type of the data. FIELD_TYPE_INT=1,FIELD_TYPE_STRING=2,FIELD_TYPE_BOOLEAN=3,
FIELD_TYPE_FLOAT = 4, FIELD_TYPE_TIME=5. Arrays of these types are not acceptable.theLength
- If data type is a string, the length of data stored. Pass in 0,
for all other types.VWException,
- if there are errors.public void deleteFieldDefinition(java.lang.String theName) throws VWException
theName
- the name of the exposed field to be deleted from the queue.VWException,
- if name not found.public VWIndexDefinition createIndexDefinition(java.lang.String theName, java.lang.String[] theFieldNames) throws VWException
theName
- The name of the field.theFieldNames
- An array of System fields and/or user defined exposed fields.VWException,
- if errors found in the name or undefined fields used to define
the index.public void deleteIndexDefinition(java.lang.String theName) throws VWException
theName
- the name of the index to be deleted from the queue.VWException,
- if index not found.public VWExposedFieldDefinition[] getFields() throws VWException
Thrown
- if there is an error.public VWIndexDefinition[] getIndexes() throws VWException
Thrown
- if there is an error.public java.lang.String getDescription()
public void setDescription(java.lang.String theDescription)
theDescription
- a description for this table definition.public java.lang.String getName()
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |