org.dataone.service.types.v1_1

Class QueryEngineDescription

java.lang.Object

org.dataone.service.types.v1_1.QueryEngineDescription

All Implemented Interfaces:

Serializable

public class QueryEngineDescription
extends Object
implements Serializable

Describes a query engine that can be used to search content on the node. Query engines may be general purpose or specialized for particular communities or domains. Schema fragment(s) for this class:

 <xs:complexType xmlns:ns="http://ns.dataone.org/service/types/v1.1" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="QueryEngineDescription">
   <xs:sequence>
     <xs:element type="xs:string" name="queryEngineVersion" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:string" name="querySchemaVersion" minOccurs="0" maxOccurs="1"/>
     <xs:element type="xs:string" name="name" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:string" name="additionalInfo" minOccurs="0" maxOccurs="unbounded"/>
     <xs:element type="ns:QueryField" name="queryField" minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
 </xs:complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	additionalInfo
protected String	name
protected String	queryEngineVersion
protected List<QueryField>	queryField
protected String	querySchemaVersion

Constructor Summary

Constructors

Constructor and Description
QueryEngineDescription()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAdditionalInfo(String item) Add a 'additionalInfo' element item.
void	addQueryField(QueryField item) Add a 'queryField' element item.
void	clearAdditionalInfoList() Remove all 'additionalInfo' element items.
void	clearQueryFieldList() Remove all 'queryField' element items.
String	getAdditionalInfo(int index) Get 'additionalInfo' element item by position.
List<String>	getAdditionalInfoList() Get the list of 'additionalInfo' element items.
String	getName() Get the 'name' element value.
String	getQueryEngineVersion() Get the 'queryEngineVersion' element value.
QueryField	getQueryField(int index) Get 'queryField' element item by position.
List<QueryField>	getQueryFieldList() Get the list of 'queryField' element items.
String	getQuerySchemaVersion() Get the 'querySchemaVersion' element value.
void	setAdditionalInfoList(List<String> list) Set the list of 'additionalInfo' element items.
void	setName(String name) Set the 'name' element value.
void	setQueryEngineVersion(String queryEngineVersion) Set the 'queryEngineVersion' element value.
void	setQueryFieldList(List<QueryField> list) Set the list of 'queryField' element items.
void	setQuerySchemaVersion(String querySchemaVersion) Set the 'querySchemaVersion' element value.
int	sizeAdditionalInfoList() Get the number of 'additionalInfo' element items.
int	sizeQueryFieldList() Get the number of 'queryField' element items.

Methods inherited from class java.lang.Object

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

Field Detail

queryEngineVersion

protected String queryEngineVersion

querySchemaVersion

protected String querySchemaVersion

name

protected String name

additionalInfo

protected List<String> additionalInfo

queryField

protected List<QueryField> queryField

Constructor Detail

QueryEngineDescription

public QueryEngineDescription()

Method Detail

getQueryEngineVersion

public String getQueryEngineVersion()

Get the 'queryEngineVersion' element value. The version of the underlying query engine. Used by clients to determine possible compatibility concerns or features available.

Returns:

value

setQueryEngineVersion

public void setQueryEngineVersion(String queryEngineVersion)

Set the 'queryEngineVersion' element value. The version of the underlying query engine. Used by clients to determine possible compatibility concerns or features available.

Parameters:

queryEngineVersion -

getQuerySchemaVersion

public String getQuerySchemaVersion()

Get the 'querySchemaVersion' element value. Version of the schema in use by the query engine, e.g. "1.0.1"

Returns:

value

setQuerySchemaVersion

public void setQuerySchemaVersion(String querySchemaVersion)

Set the 'querySchemaVersion' element value. Version of the schema in use by the query engine, e.g. "1.0.1"

Parameters:

querySchemaVersion -

getName

public String getName()

Get the 'name' element value. The full, human readable name of the query engine. For example: "Apache SOLR"

Returns:

value

setName

public void setName(String name)

Set the 'name' element value. The full, human readable name of the query engine. For example: "Apache SOLR"

Parameters:

name -

getAdditionalInfoList

public List<String> getAdditionalInfoList()

Get the list of 'additionalInfo' element items. An optional human readable description of the query engine. This can be used to describe any special capabilities or intended uses for the query engine. For example, a query engine may be tuned to suit a particular audience or domain as opposed to providing a general purpose discovery mechanism.This field may also contain links to additional information about the query engine, such as documentation for the search syntax provided by the query engine implemntors.

Returns:

list

setAdditionalInfoList

public void setAdditionalInfoList(List<String> list)

Set the list of 'additionalInfo' element items. An optional human readable description of the query engine. This can be used to describe any special capabilities or intended uses for the query engine. For example, a query engine may be tuned to suit a particular audience or domain as opposed to providing a general purpose discovery mechanism.This field may also contain links to additional information about the query engine, such as documentation for the search syntax provided by the query engine implemntors.

Parameters:

list -

sizeAdditionalInfoList

public int sizeAdditionalInfoList()

Get the number of 'additionalInfo' element items.

Returns:

count

addAdditionalInfo

public void addAdditionalInfo(String item)

Add a 'additionalInfo' element item.

Parameters:

item -

getAdditionalInfo

public String getAdditionalInfo(int index)

Get 'additionalInfo' element item by position.

Parameters:

index -

Returns:

item

clearAdditionalInfoList

public void clearAdditionalInfoList()

Remove all 'additionalInfo' element items.

getQueryFieldList

public List<QueryField> getQueryFieldList()

Get the list of 'queryField' element items. A list of query fields supported by the query engine.

Returns:

list

setQueryFieldList

public void setQueryFieldList(List<QueryField> list)

Set the list of 'queryField' element items. A list of query fields supported by the query engine.

Parameters:

list -

sizeQueryFieldList

public int sizeQueryFieldList()

Get the number of 'queryField' element items.

Returns:

count

addQueryField

public void addQueryField(QueryField item)

Add a 'queryField' element item.

Parameters:

item -

getQueryField

public QueryField getQueryField(int index)

Get 'queryField' element item by position.

Parameters:

index -

Returns:

item

clearQueryFieldList

public void clearQueryFieldList()

Remove all 'queryField' element items.