org.ecoinformatics.seek.ecogrid.quicksearch

Class ResultRecord

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

ptolemy.actor.lib.Source

org.ecoinformatics.seek.ecogrid.quicksearch.ResultRecord

All Implemented Interfaces:

java.lang.Cloneable, DataSourceInterface, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Direct Known Subclasses:

Eml200DataSource

public class ResultRecord
extends Source
implements DataSourceInterface

A class that represents a single record from a query result. This class is used to display the records in a tree view in the tree view on the left of the Kepler interface.

Author:

Matt Jones and Jing Tao

See Also:

ResultPane

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
SingletonParameter	hide

Fields inherited from class ptolemy.actor.lib.Source

_triggered, output, trigger

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface org.kepler.dataproxy.datasource.DataSourceInterface

BLACK, ENDPOINT, MAGENTA, NAMESPACE, RECORDID, RED, TITLE_BINARY, TITLE_BUSY, TITLE_ERROR, YELLOW

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor and Description
ResultRecord(CompositeEntity container, java.lang.String name) Create a new ResultRecord with the given name.

Method Summary

Modifier and Type	Method and Description
void	addRecordDetail(java.lang.String detail) Add one or more detail attributes to the record.
java.lang.Object	clone(Workspace workspace) Clone the ResultRecord into the specified workspace.
java.net.URL	getDocumentation() Get a URL pointer to the documentation for this data source.
java.lang.String	getEndpoint() Get the endpoint of this record.
java.io.Reader	getFullRecord()
java.lang.String	getNamespace() Get the namespace of this record.
java.util.Vector	getRecordDetailList() Get the recordDetailsList in this entity
java.lang.String	getRecordId() Get the identifier of this record.
boolean	hasConnectionValues() Determine if the recordId and endpoint attributes have valid values for use in retrieving the record for parsing.
void	setEndpoint(java.lang.String endpoint) Set the endpoint of this record.
void	setNamespace(java.lang.String namespace) Set the namespace of this record.
void	setRecordId(java.lang.String id) Set the identifier of this record.
static void	transformResultRecordArrayToVector(ResultRecord[] source, java.util.Vector dest) Method to transfer a array of ResultRecord to a Vector

Methods inherited from class ptolemy.actor.lib.Source

_customTypeConstraints, fire, prefire

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, isStrict, iterate, postfire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

hide

public SingletonParameter hide

Constructor Detail

ResultRecord

public ResultRecord(CompositeEntity container,
                    java.lang.String name)
             throws NameDuplicationException,
                    IllegalActionException

Create a new ResultRecord with the given name. The name is used to display the record in various user interface views.

Parameters:

container - The model that contains this entity.

name - The name of this result set resord.

Throws:

IllegalActionException - If the actor cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

Method Detail

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Clone the ResultRecord into the specified workspace.

Overrides:

clone in class TypedAtomicActor

Parameters:

workspace - The workspace for the new object.

Returns:

A new actor.

Throws:

java.lang.CloneNotSupportedException - If a derived class contains an attribute that cannot be cloned.

See Also:

NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

setRecordId

public void setRecordId(java.lang.String id)

Set the identifier of this record.

Parameters:

id - the String that uniquely identifies the record

getRecordId

public java.lang.String getRecordId()

Get the identifier of this record.

Returns:

the String that uniquely identifies the record

setEndpoint

public void setEndpoint(java.lang.String endpoint)

Set the endpoint of this record. The endpoint indicates where the service generating the record can be accessed.

Parameters:

endpoint - the URL of the service that contains the record

getEndpoint

public java.lang.String getEndpoint()

Get the endpoint of this record. The endpoint indicates where the service generating the record can be accessed.

Returns:

endpoint the URL of the service that contains the record

setNamespace

public void setNamespace(java.lang.String namespace)

Set the namespace of this record. The namespace indicates the document type

Parameters:

endpoint - the URL of the service that contains the record

getNamespace

public java.lang.String getNamespace()

Get the namespace of this record.

Returns:

namespace the URL of the service that contains the record

addRecordDetail

public void addRecordDetail(java.lang.String detail)

Add one or more detail attributes to the record. These detail attributes are displayed in the user interface below the record for additional information about the record.

Parameters:

detail - the additional information about the record

hasConnectionValues

public boolean hasConnectionValues()

Determine if the recordId and endpoint attributes have valid values for use in retrieving the record for parsing.

Returns:

boolean true if both recordid and endpoint are not null and are not the empty string

getFullRecord

public java.io.Reader getFullRecord()

getDocumentation

public java.net.URL getDocumentation()

Description copied from interface: DataSourceInterface

Get a URL pointer to the documentation for this data source.

Specified by:

getDocumentation in interface DataSourceInterface

Returns:

URL the URL of the HTML file containing the documentation

transformResultRecordArrayToVector

public static void transformResultRecordArrayToVector(ResultRecord[] source,
                                                      java.util.Vector dest)

Method to transfer a array of ResultRecord to a Vector

Parameters:

source - the source array of ResultRecord

dest - the destation vector the element will be added.

getRecordDetailList

public java.util.Vector getRecordDetailList()

Get the recordDetailsList in this entity