org.kepler.objectmanager.repository

Class EcogridRepositoryResults

java.lang.Object

org.kepler.objectmanager.repository.EcogridRepositoryResults

public class EcogridRepositoryResults
extends java.lang.Object

This class represents a single result from a search of the ecogrid repository. If there are many results (as in a resultset), then multiple EcogridRepositoryResults can be put into an iterator.

Author:

Chad Berkley

Constructor Summary

Constructors

Constructor and Description
EcogridRepositoryResults(KarXml.KarEntry karEntry, java.lang.String repositoryName, int indexValue, java.lang.String karLSID)
EcogridRepositoryResults(org.ecoinformatics.ecogrid.queryservice.resultset.ResultsetTypeRecord record, java.lang.String repositoryName, boolean authenticate) default constructor
EcogridRepositoryResults(java.lang.String karLSID, java.lang.String repositoryName, boolean authenticate)

Method Summary

Modifier and Type	Method and Description
java.io.File	cacheKAR(boolean authenticate) download the kar file and get it ready to be imported into the local system.
CacheObject	getCacheObject()
ComponentEntity	getComponent() return the instantiated
java.lang.String	getDocid() return the docid of the result
java.lang.Integer	getIndexValue() All EcogridRepositoryResults produced by a single call to parseKarXml() will be assigned the same index value so they can later be put under a common KAR file.
KarXml.KarEntry	getKarEntry()
java.lang.String	getKarLSID() return the lsid of the kar file associated with this component
java.lang.String	getLSID() return the lsid (entityId) of the component
java.lang.String	getName() return the name of the component
java.util.Vector<java.lang.String>	getSemanticTypes() return any semantic types associated with this component
boolean	hasException() returns true if the kar caching thread has thrown an exception
boolean	isReady() returns true of the kar file from this result is ready for use
static java.util.List<EcogridRepositoryResults>	parseKarXml(java.lang.String docid, java.lang.String repositoryName, int indexValue, boolean authenticate)
void	setDocId(java.lang.String docid) Set the docid (kar xml id)
void	setDownloader(KARDownloader downloader)
java.lang.String	toString() return a string rep of this object

Methods inherited from class java.lang.Object

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

Constructor Detail

EcogridRepositoryResults

public EcogridRepositoryResults(java.lang.String karLSID,
                                java.lang.String repositoryName,
                                boolean authenticate)

EcogridRepositoryResults

public EcogridRepositoryResults(KarXml.KarEntry karEntry,
                                java.lang.String repositoryName,
                                int indexValue,
                                java.lang.String karLSID)
                         throws RepositoryException

Throws:

RepositoryException

EcogridRepositoryResults

public EcogridRepositoryResults(org.ecoinformatics.ecogrid.queryservice.resultset.ResultsetTypeRecord record,
                                java.lang.String repositoryName,
                                boolean authenticate)
                         throws RepositoryException

default constructor

Throws:

RepositoryException

Method Detail

parseKarXml

public static java.util.List<EcogridRepositoryResults> parseKarXml(java.lang.String docid,
                                                                   java.lang.String repositoryName,
                                                                   int indexValue,
                                                                   boolean authenticate)
                                                            throws RepositoryException

Throws:

RepositoryException

getIndexValue

public java.lang.Integer getIndexValue()

All EcogridRepositoryResults produced by a single call to parseKarXml() will be assigned the same index value so they can later be put under a common KAR file. The index value is guaranteed to be unique to the contents of one KAR file only within the results produced by a single call to EcogridRepository.search(). Subsequent calls *will* produce colliding values.

Returns:

The index value shared by all EcogridRepositoryResults instances generated from the same KAR file. Calls to this method by EcogridRepositoryResults instances that were not generated through parsing a KAR XML file will produce null.

getKarEntry

public KarXml.KarEntry getKarEntry()

cacheKAR

public java.io.File cacheKAR(boolean authenticate)
                      throws RepositoryException

download the kar file and get it ready to be imported into the local system.

Throws:

RepositoryException

isReady

public boolean isReady()

returns true of the kar file from this result is ready for use

hasException

public boolean hasException()

returns true if the kar caching thread has thrown an exception

toString

public java.lang.String toString()

return a string rep of this object

Overrides:

toString in class java.lang.Object

getDocid

public java.lang.String getDocid()

return the docid of the result

getName

public java.lang.String getName()

return the name of the component

getLSID

public java.lang.String getLSID()

return the lsid (entityId) of the component

getKarLSID

public java.lang.String getKarLSID()

return the lsid of the kar file associated with this component

getSemanticTypes

public java.util.Vector<java.lang.String> getSemanticTypes()

return any semantic types associated with this component

getCacheObject

public CacheObject getCacheObject()

getComponent

public ComponentEntity getComponent()

return the instantiated

setDocId

public void setDocId(java.lang.String docid)

Set the docid (kar xml id)

Parameters:

docid -

setDownloader

public void setDownloader(KARDownloader downloader)