Package COM.TIBCO.hawk.talon

Class CompositeDataDescriptor

java.lang.Object

COM.TIBCO.hawk.talon.DataDescriptor

COM.TIBCO.hawk.talon.CompositeDataDescriptor

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TabularDataDescriptor

public class CompositeDataDescriptor
extends DataDescriptor

This subclass of DataDescriptor is used to describe objects of type CompositeData.

The value returned by its getElementDescriptors() method describes all the elements in the composite.

Default value, legal value choices, and value choices are not supported for CompositeDataDescriptor.

See Also:

• CompositeData
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CompositeDataDescriptor(String name, String desc, DataDescriptor[] elementDescriptors)	Constructs a CompositeDataDescriptor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Compares this object against the specified object.
DataDescriptor[]	getElementDescriptors()	Returns the descriptors of the aggregated elements
boolean	isOpenData()	Returns true if this descriptor describes an open data type.
String	toString()	Returns a string representation of this descriptor.

Methods inherited from class COM.TIBCO.hawk.talon.DataDescriptor

getDefault, getDescription, getLegalValueChoices, getName, getType, getValueChoices

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

CompositeDataDescriptor

public CompositeDataDescriptor(String name,
 String desc,
 DataDescriptor[] elementDescriptors)

Constructs a CompositeDataDescriptor.

Note that a type parameter is not required as in DataDescriptor, it is implicitly the CompositeData type.

Parameters:

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 described.

elementDescriptors - An array of descriptors describing the components of the CompositeData. It must contain DataDescriptor objects that describe only open data types. All elements must have unique names. It can not be null or empty array. The array can not contain null elements.

See Also:

• DataDescriptor

Method Details

getElementDescriptors

public DataDescriptor[] getElementDescriptors()

Returns the descriptors of the aggregated elements

isOpenData

public boolean isOpenData()

Returns true if this descriptor describes an open data type.

This overridden method will always return true for this subclass of DataDescriptor because the constructor insures that only the open data type CompositeData may be described.

Overrides:

isOpenData in class DataDescriptor

Returns:

True if this descriptor describes an open data type.

See Also:

• OpenData
• CompositeDataDescriptor
• TabularDataDescriptor

equals

public boolean equals(Object obj)

Compares this object against the specified object.

Two descriptors are equal if their name, type, description, and DataDescriptor elements are equal.

Overrides:

equals in class DataDescriptor

Returns:

true if the two objects are equal.

toString

public String toString()

Returns a string representation of this descriptor.

Overrides:

toString in class DataDescriptor