com.esri.gpt.catalog.discovery
Class Returnable

java.lang.Object
  com.esri.gpt.catalog.discovery.DiscoveryComponent
      com.esri.gpt.catalog.discovery.Discoverable
          com.esri.gpt.catalog.discovery.Returnable

public class Returnable
extends Discoverable

A discoverable property that contains an Object array of associated stored values the were discovered through query.

Constructor Summary

protected

Returnable(Discoverable objectToBaseOn, Object[] values) Constructs a returnable based upon a discoverable and it's associated values.

Method Summary

void	echo(StringBuffer sb, int depth) Appends property information for the component to a buffer.
Object[]	getValues() Gets the underlying data store values associated with the discoverable target.

Methods inherited from class com.esri.gpt.catalog.discovery.Discoverable

asSortable, echo, getMeaning, getStorable, setMeaning, setStoreable

Methods inherited from class com.esri.gpt.catalog.discovery.DiscoveryComponent

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Returnable

protected Returnable(Discoverable objectToBaseOn,
                     Object[] values)

Constructs a returnable based upon a discoverable and it's associated values.

Parameters:

objectToBaseOn - the discoverable target that serves as the base

values - the data store values associated with the discoverable

Method Detail

getValues

public Object[] getValues()

Gets the underlying data store values associated with the discoverable target.

The values array will be null if the field was not populated within the associated document.

There can be multiple values associated with a field, keywords for instance.

The Objects in the array will be typed with the property value type returned by the getMeaning().getValueType() method for this class. As an example if getMeaning().getValueType() returns PropertyValueType.TIMESTAMP, you can cast an object as:
(java.sql.Timestamp)getValues()[0]

Returns:

the data store field values

echo

public void echo(StringBuffer sb,
                 int depth)

Appends property information for the component to a buffer.

Overrides:

echo in class Discoverable

Parameters:

sb - the buffer to use when appending information

depth - the depth of the parent clause