com.esri.gpt.catalog.discovery
Class Sortable

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

public class Sortable
extends Discoverable

Represents a stored property that can be be used to sort the results of a query.

Nested Class Summary

static class

Sortable.SortDirection The enumeration of sorting directions.

Constructor Summary

Sortable(Discoverable objectToBaseOn)
Constructs a sortable based upon a discoverable.

Method Summary

void	echo(StringBuffer sb, int depth) Appends property information for the component to a buffer.
Sortable.SortDirection	getDirection() Gets the sort direction.
void	setDirection(Sortable.SortDirection direction) Sets the sort direction.

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

Sortable

public Sortable(Discoverable objectToBaseOn)

Constructs a sortable based upon a discoverable.

Parameters:

objectToBaseOn - the discoverable that serves as the base

Method Detail

getDirection

public Sortable.SortDirection getDirection()

Gets the sort direction.

Returns:

the sort direction

setDirection

public void setDirection(Sortable.SortDirection direction)

Sets the sort direction.

Parameters:

direction - the sort direction

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