org.kepler.dataproxy.metadata.ADN

Class ADNMetadataSpecification

java.lang.Object

org.ecoinformatics.seek.ecogrid.MetadataSpecificationInterface

org.kepler.dataproxy.metadata.ADN.ADNMetadataSpecification

public class ADNMetadataSpecification
extends MetadataSpecificationInterface

This class is a plugin for adn namespace to transfer query group to ecogrid query type. It also provide a method to create quick search query

Author:

Efrat Jaeger-Frank

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADNNAMESPACE
protected static org.apache.commons.logging.Log	log
protected java.lang.String	namespace
protected java.lang.String	queryId

Fields inherited from class org.ecoinformatics.seek.ecogrid.MetadataSpecificationInterface

AUTHENTICATION_MAPPING, AUTHENTICATION_SERVICECLASS, AUTHENTICATION_SERVICETYPE, DESCRIPTION, DOCUMENTTYPE, ECOGRIDPATH, ENDPOINT, LABEL, METADATACLASS, METADATASPECIFICATIONCLASSLIST, NAMESPACE, QUERYTITLE, QUICKPATH, RETURNFIELD, RETURNFIELDENTITY, RETURNFIELDTITLE, RETURNFIELDTYPE, RETURNFIELDTYPELIST, SELECTION, SERVICE, SERVICECLASSIFICATION, SERVICEGROUP, SERVICENAME, SERVICESLIST, SERVICETYPE

Constructor Summary

Constructors

Constructor and Description
ADNMetadataSpecification() Default constructor

Method Summary

Modifier and Type	Method and Description
boolean	addResultsetRecordsToContainer(org.ecoinformatics.ecogrid.queryservice.resultset.ResultsetType results, java.lang.String endpoint, CompositeEntity container, java.util.Vector aResultList) Creates GEONDataResource items (derived from Source) and adds them into the container
java.lang.String	getBriefName()
static java.net.URL	getDocumentation(java.lang.String recordId) Returns a URL to the ADN documentation
org.ecoinformatics.ecogrid.queryservice.query.QueryType	getEcoGridQuery() Method to create a ecogrid query
java.lang.String	getName()
int	getNumResults()
org.ecoinformatics.ecogrid.queryservice.query.QueryType	getQuickSearchEcoGridQuery(java.lang.String value) Method to create a quick query search
boolean	transformResultset(org.ecoinformatics.ecogrid.queryservice.resultset.ResultsetType results, java.lang.String endpoint, CompositeEntity container, java.util.Vector aResultList) This method will transfer ResultsetType java object to array of ResultRecord java object.

Methods inherited from class org.ecoinformatics.seek.ecogrid.MetadataSpecificationInterface

replaceDotByDash

Methods inherited from class java.lang.Object

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

Field Detail

ADNNAMESPACE

public static final java.lang.String ADNNAMESPACE

See Also:

Constant Field Values

namespace

protected java.lang.String namespace

queryId

protected java.lang.String queryId

log

protected static final org.apache.commons.logging.Log log

Constructor Detail

ADNMetadataSpecification

public ADNMetadataSpecification()

Default constructor

Method Detail

getDocumentation

public static java.net.URL getDocumentation(java.lang.String recordId)
                                     throws java.net.MalformedURLException

Returns a URL to the ADN documentation

Throws:

java.net.MalformedURLException

getQuickSearchEcoGridQuery

public org.ecoinformatics.ecogrid.queryservice.query.QueryType getQuickSearchEcoGridQuery(java.lang.String value)
                                                                                   throws InvalidEcogridQueryException

Method to create a quick query search

Specified by:

getQuickSearchEcoGridQuery in class MetadataSpecificationInterface

Parameters:

value - String

Returns:

QueryType

Throws:

InvalidEcogridQueryException - Description of the Exception

getEcoGridQuery

public org.ecoinformatics.ecogrid.queryservice.query.QueryType getEcoGridQuery()

Method to create a ecogrid query

Specified by:

getEcoGridQuery in class MetadataSpecificationInterface

Returns:

QueryType

transformResultset

public boolean transformResultset(org.ecoinformatics.ecogrid.queryservice.resultset.ResultsetType results,
                                  java.lang.String endpoint,
                                  CompositeEntity container,
                                  java.util.Vector aResultList)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException,
                                  EcoGridException,
                                  NameDuplicationException,
                                  IllegalActionException

This method will transfer ResultsetType java object to array of ResultRecord java object. The ResultRecord object can be shown in kepler. If the results is null or there is no record in the result, null will be return

Parameters:

ResultsetType - results the result need to be transform

String - endpoints the search end point

Returns:

ResultRecord[] the resultrecord need be returned.

Throws:

org.xml.sax.SAXException

java.io.IOException

EcoGridException

NameDuplicationException

IllegalActionException

addResultsetRecordsToContainer

public boolean addResultsetRecordsToContainer(org.ecoinformatics.ecogrid.queryservice.resultset.ResultsetType results,
                                              java.lang.String endpoint,
                                              CompositeEntity container,
                                              java.util.Vector aResultList)
                                       throws org.xml.sax.SAXException,
                                              java.io.IOException,
                                              EcoGridException,
                                              NameDuplicationException,
                                              IllegalActionException

Creates GEONDataResource items (derived from Source) and adds them into the container

Specified by:

addResultsetRecordsToContainer in class MetadataSpecificationInterface

Parameters:

aResults -

aEndPointURLStr -

aContainer -

aResultList -

Throws:

org.xml.sax.SAXException

java.io.IOException

EcoGridException

NameDuplicationException

IllegalActionException

getName

public java.lang.String getName()

Specified by:

getName in class MetadataSpecificationInterface

Returns:

Returns a unique name that descrobes this class, often it is the name of the class that implments the interface

getBriefName

public java.lang.String getBriefName()

Specified by:

getBriefName in class MetadataSpecificationInterface

Returns:

Returns the Data Source Type Name

getNumResults

public int getNumResults()

Specified by:

getNumResults in class MetadataSpecificationInterface

Returns:

returns the number of results that for this data.