org.dataone.service.types.v1_1

Class QueryEngineList

java.lang.Object

org.dataone.service.types.v1_1.QueryEngineList

All Implemented Interfaces:

Serializable

public class QueryEngineList
extends Object
implements Serializable

A list of query engine names that indicate the possible values for CNRead.getQueryEngineDescription and CNRead.query REST API endpoints. 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="QueryEngineList">
   <xs:sequence>
     <xs:element type="xs:string" name="queryEngine" minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
 </xs:complexType>
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QueryEngineList()

Method Summary

Methods

Modifier and Type	Method and Description
void	addQueryEngine(String item) Add a 'queryEngine' element item.
void	clearQueryEngineList() Remove all 'queryEngine' element items.
String	getQueryEngine(int index) Get 'queryEngine' element item by position.
List<String>	getQueryEngineList() Get the list of 'queryEngine' element items.
void	setQueryEngineList(List<String> list) Set the list of 'queryEngine' element items.
int	sizeQueryEngineList() Get the number of 'queryEngine' element items.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryEngineList

public QueryEngineList()

Method Detail

getQueryEngineList

public List<String> getQueryEngineList()

Get the list of 'queryEngine' element items. The name of a queryEngine. This value will be used as a path element in REST API calls and so should not contain characters that will need to be escaped.

Returns:

list

setQueryEngineList

public void setQueryEngineList(List<String> list)

Set the list of 'queryEngine' element items. The name of a queryEngine. This value will be used as a path element in REST API calls and so should not contain characters that will need to be escaped.

Parameters:

list -

sizeQueryEngineList

public int sizeQueryEngineList()

Get the number of 'queryEngine' element items.

Returns:

count

addQueryEngine

public void addQueryEngine(String item)

Add a 'queryEngine' element item.

Parameters:

item -

getQueryEngine

public String getQueryEngine(int index)

Get 'queryEngine' element item by position.

Parameters:

index -

Returns:

item

clearQueryEngineList

public void clearQueryEngineList()

Remove all 'queryEngine' element items.