public final class TabularDataDescriptor extends CompositeDataDescriptor
Constructor and Description |
---|
TabularDataDescriptor(java.lang.String name,
java.lang.String desc,
DataDescriptor[] elementDescriptors,
java.lang.String[] indexNames)
Constructs a TabularDataDescriptor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Compares this object against the specified object.
|
java.lang.String[] |
getColumnNames()
Returns an array of the column names derived from the DataDescriptor elements
used to construct this descriptor.
|
java.lang.String[] |
getColumnTypes()
Returns an array of column types derived from the DataDescriptor elements
used to construct this descriptor.
|
java.lang.String[] |
getIndexNames()
Returns an array of the index names used to construct this table descriptor.
|
boolean |
isOpenData()
Returns true if this descriptor describes an open data type.
|
java.lang.String |
toString()
Returns a string representation of this descriptor.
|
getElementDescriptors
getDefault, getDescription, getLegalValueChoices, getName, getType, getValueChoices
public TabularDataDescriptor(java.lang.String name, java.lang.String desc, DataDescriptor[] elementDescriptors, java.lang.String[] indexNames)
Note that a type
parameter is not required as in DataDescriptor,
it is implicitly the TabularData type.
name
- The name of the data parameter being described. It must be a non-null,
non-empty alpha numeric string.desc
- A description of the parameter being describedelementDescriptors
- can not be null or empty array. The array can not contain
null elements. It must contain DataDescriptor objects
that describe open data types. All elements must have unique names.
Each descriptor describes a single column in the table, its name
is the column's name and its type describes the type of the data
the column will hold.indexNames
- Identifies those columns of the table that
can be used as a unique index for each row.
Must identify at least one index column.
All index names must be non-null and non-empty strings.
No two array entries may contain the same string.
All index names identified by this array must have a
corresponding DataDescriptor
in the array specified by the elementDescriptors
parameter.public java.lang.String[] getIndexNames()
public java.lang.String[] getColumnNames()
public java.lang.String[] getColumnTypes()
getColumnNames()
at the same array index.public boolean isOpenData()
This overridden method will always return true for this subclass of DataDescriptor
because the constructor insures that only the open data type TabularData
may be described.
isOpenData
in class CompositeDataDescriptor
public boolean equals(java.lang.Object obj)
Two descriptors are equal if their name, type, description, index names and DataDescriptor elements are equal.
equals
in class CompositeDataDescriptor
public java.lang.String toString()
toString
in class CompositeDataDescriptor
Copyright © 2000-2019 TIBCO Inc. All Rights Reserved.