org.ecoinformatics.seek.ecogrid

Class MetadataSpecificationInterface

java.lang.Object

org.ecoinformatics.seek.ecogrid.MetadataSpecificationInterface

Direct Known Subclasses:

ADNMetadataSpecification, DarwinCoreMetaDataSpecification, EML2MetadataSpecification

public abstract class MetadataSpecificationInterface
extends java.lang.Object

Title:PlugInQueryTransferInterface

Description: This is a plugin interface and it defines a all methods any metadata type should implement into order to search ecogrid service and parse the results

Copyright: Copyright (c) 2004

Company:

Author:

not attributable

Created:

February 17, 2005

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHENTICATION_MAPPING
static java.lang.String	AUTHENTICATION_SERVICECLASS
static java.lang.String	AUTHENTICATION_SERVICETYPE
static java.lang.String	DESCRIPTION
static java.lang.String	DOCUMENTTYPE Description of the Field
static java.lang.String	ECOGRIDPATH Description of the Field
static java.lang.String	ENDPOINT Description of the Field
static java.lang.String	LABEL Description of the Field
static java.lang.String	METADATACLASS Description of the Field
static java.lang.String	METADATASPECIFICATIONCLASSLIST Description of the Field
static java.lang.String	NAMESPACE Description of the Field
static java.lang.String	QUERYTITLE Description of the Field
static java.lang.String	QUICKPATH Description of the Field
static java.lang.String	RETURNFIELD Description of the Field
static java.lang.String	RETURNFIELDENTITY Description of the Field
static java.lang.String	RETURNFIELDTITLE Description of the Field
static java.lang.String	RETURNFIELDTYPE Description of the Field
static java.lang.String	RETURNFIELDTYPELIST Description of the Field
static java.lang.String	SELECTION Description of the field
static java.lang.String	SERVICE Description of the Field
static java.lang.String	SERVICECLASSIFICATION
static java.lang.String	SERVICEGROUP field for service clustering/authentication
static java.lang.String	SERVICENAME Description of the Field
static java.lang.String	SERVICESLIST Description of the Field
static java.lang.String	SERVICETYPE Description of the Field

Constructor Summary

Constructors

Constructor and Description
MetadataSpecificationInterface()

Method Summary

Modifier and Type	Method and Description
abstract boolean	addResultsetRecordsToContainer(org.ecoinformatics.ecogrid.queryservice.resultset.ResultsetType results, java.lang.String endpoint, CompositeEntity container, java.util.Vector aResultList) The ResultSet is added directly to the container
abstract java.lang.String	getBriefName()
abstract org.ecoinformatics.ecogrid.queryservice.query.QueryType	getEcoGridQuery() This method will transfer a query group into ecogrid query base on different namespace
abstract java.lang.String	getName()
abstract int	getNumResults()
abstract org.ecoinformatics.ecogrid.queryservice.query.QueryType	getQuickSearchEcoGridQuery(java.lang.String value) This method will return a quick search query base on the given value
static java.lang.String	replaceDotByDash(java.lang.String originalString)

Methods inherited from class java.lang.Object

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

Field Detail

RETURNFIELD

public static final java.lang.String RETURNFIELD

Description of the Field

See Also:

Constant Field Values

RETURNFIELDTYPE

public static final java.lang.String RETURNFIELDTYPE

Description of the Field

See Also:

Constant Field Values

RETURNFIELDTITLE

public static final java.lang.String RETURNFIELDTITLE

Description of the Field

See Also:

Constant Field Values

RETURNFIELDENTITY

public static final java.lang.String RETURNFIELDENTITY

Description of the Field

See Also:

Constant Field Values

NAMESPACE

public static final java.lang.String NAMESPACE

Description of the Field

See Also:

Constant Field Values

QUICKPATH

public static final java.lang.String QUICKPATH

Description of the Field

See Also:

Constant Field Values

QUERYTITLE

public static final java.lang.String QUERYTITLE

Description of the Field

See Also:

Constant Field Values

ENDPOINT

public static final java.lang.String ENDPOINT

Description of the Field

See Also:

Constant Field Values

METADATACLASS

public static final java.lang.String METADATACLASS

Description of the Field

See Also:

Constant Field Values

ECOGRIDPATH

public static final java.lang.String ECOGRIDPATH

Description of the Field

See Also:

Constant Field Values

SERVICESLIST

public static final java.lang.String SERVICESLIST

Description of the Field

See Also:

Constant Field Values

SERVICE

public static final java.lang.String SERVICE

Description of the Field

See Also:

Constant Field Values

SERVICENAME

public static final java.lang.String SERVICENAME

Description of the Field

See Also:

Constant Field Values

SERVICETYPE

public static final java.lang.String SERVICETYPE

Description of the Field

See Also:

Constant Field Values

DOCUMENTTYPE

public static final java.lang.String DOCUMENTTYPE

Description of the Field

See Also:

Constant Field Values

LABEL

public static final java.lang.String LABEL

Description of the Field

See Also:

Constant Field Values

RETURNFIELDTYPELIST

public static final java.lang.String RETURNFIELDTYPELIST

Description of the Field

See Also:

Constant Field Values

METADATASPECIFICATIONCLASSLIST

public static final java.lang.String METADATASPECIFICATIONCLASSLIST

Description of the Field

See Also:

Constant Field Values

SELECTION

public static final java.lang.String SELECTION

Description of the field

See Also:

Constant Field Values

SERVICEGROUP

public static final java.lang.String SERVICEGROUP

field for service clustering/authentication

See Also:

Constant Field Values

SERVICECLASSIFICATION

public static final java.lang.String SERVICECLASSIFICATION

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

AUTHENTICATION_MAPPING

public static final java.lang.String AUTHENTICATION_MAPPING

See Also:

Constant Field Values

AUTHENTICATION_SERVICETYPE

public static final java.lang.String AUTHENTICATION_SERVICETYPE

See Also:

Constant Field Values

AUTHENTICATION_SERVICECLASS

public static final java.lang.String AUTHENTICATION_SERVICECLASS

See Also:

Constant Field Values

Constructor Detail

MetadataSpecificationInterface

public MetadataSpecificationInterface()

Method Detail

getQuickSearchEcoGridQuery

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

This method will return a quick search query base on the given value

Parameters:

value - String

Returns:

QueryType

Throws:

InvalidEcogridQueryException - Description of the Exception

getEcoGridQuery

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

This method will transfer a query group into ecogrid query base on different namespace

Returns:

QueryType

addResultsetRecordsToContainer

public abstract 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

The ResultSet is added directly to the container

Parameters:

results -

endpoint -

container -

aResultList - The feature to be added to the ResultsetRecordsToContainer attribute *@throws SAXException

Throws:

java.io.IOException

EcoGridException

NameDuplicationException

IllegalActionException

org.xml.sax.SAXException

getName

public abstract java.lang.String getName()

Returns:

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

getBriefName

public abstract java.lang.String getBriefName()

Returns:

Returns the Data Source Type Name

getNumResults

public abstract int getNumResults()

Returns:

returns the number of results that for this data.

replaceDotByDash

public static java.lang.String replaceDotByDash(java.lang.String originalString)