org.dataone.service.types.v1_1

Class QueryField

java.lang.Object

org.dataone.service.types.v1_1.QueryField

All Implemented Interfaces:

Serializable

public class QueryField
extends Object
implements Serializable

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="QueryField">
   <xs:sequence>
     <xs:element type="xs:string" name="name" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:string" name="description" minOccurs="0" maxOccurs="unbounded"/>
     <xs:element type="xs:string" name="type" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:boolean" name="searchable" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:boolean" name="returnable" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:boolean" name="sortable" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:boolean" name="multivalued" minOccurs="0" maxOccurs="1"/>
   </xs:sequence>
 </xs:complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	description
protected Boolean	multivalued
protected String	name
protected boolean	returnable
protected boolean	searchable
protected boolean	sortable
protected String	type

Constructor Summary

Constructors

Constructor and Description
QueryField()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDescription(String item) Add a 'description' element item.
void	clearDescriptionList() Remove all 'description' element items.
String	getDescription(int index) Get 'description' element item by position.
List<String>	getDescriptionList() Get the list of 'description' element items.
Boolean	getMultivalued() Get the 'multivalued' element value.
String	getName() Get the 'name' element value.
String	getType() Get the 'type' element value.
boolean	isReturnable() Get the 'returnable' element value.
boolean	isSearchable() Get the 'searchable' element value.
boolean	isSortable() Get the 'sortable' element value.
void	setDescriptionList(List<String> list) Set the list of 'description' element items.
void	setMultivalued(Boolean multivalued) Set the 'multivalued' element value.
void	setName(String name) Set the 'name' element value.
void	setReturnable(boolean returnable) Set the 'returnable' element value.
void	setSearchable(boolean searchable) Set the 'searchable' element value.
void	setSortable(boolean sortable) Set the 'sortable' element value.
void	setType(String type) Set the 'type' element value.
int	sizeDescriptionList() Get the number of 'description' element items.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

description

protected List<String> description

type

protected String type

searchable

protected boolean searchable

returnable

protected boolean returnable

sortable

protected boolean sortable

multivalued

protected Boolean multivalued

Constructor Detail

QueryField

public QueryField()

Method Detail

getName

public String getName()

Get the 'name' element value. The name of the field as used programmatically when constructing queries or other rferences to the field.

Returns:

value

setName

public void setName(String name)

Set the 'name' element value. The name of the field as used programmatically when constructing queries or other rferences to the field.

Parameters:

name -

getDescriptionList

public List<String> getDescriptionList()

Get the list of 'description' element items. An optional, repeatable, brief description of the field that can be used to help guide developers or end users in appropriate use of the field. May for example, contain a links to additional documentation.

Returns:

list

setDescriptionList

public void setDescriptionList(List<String> list)

Set the list of 'description' element items. An optional, repeatable, brief description of the field that can be used to help guide developers or end users in appropriate use of the field. May for example, contain a links to additional documentation.

Parameters:

list -

sizeDescriptionList

public int sizeDescriptionList()

Get the number of 'description' element items.

Returns:

count

addDescription

public void addDescription(String item)

Add a 'description' element item.

Parameters:

item -

getDescription

public String getDescription(int index)

Get 'description' element item by position.

Parameters:

index -

Returns:

item

clearDescriptionList

public void clearDescriptionList()

Remove all 'description' element items.

getType

public String getType()

Get the 'type' element value. The type of the field, expressed in the language peculiar to the query engine being described.

Returns:

value

setType

public void setType(String type)

Set the 'type' element value. The type of the field, expressed in the language peculiar to the query engine being described.

Parameters:

type -

isSearchable

public boolean isSearchable()

Get the 'searchable' element value. Indicates if the field may be used in constructing queries (as opposed to only appearing in results)

Returns:

value

setSearchable

public void setSearchable(boolean searchable)

Set the 'searchable' element value. Indicates if the field may be used in constructing queries (as opposed to only appearing in results)

Parameters:

searchable -

isReturnable

public boolean isReturnable()

Get the 'returnable' element value. Indicates if the field values may be returned in search results.

Returns:

value

setReturnable

public void setReturnable(boolean returnable)

Set the 'returnable' element value. Indicates if the field values may be returned in search results.

Parameters:

returnable -

isSortable

public boolean isSortable()

Get the 'sortable' element value. Indicates if the field can be used for sorting results.

Returns:

value

setSortable

public void setSortable(boolean sortable)

Set the 'sortable' element value. Indicates if the field can be used for sorting results.

Parameters:

sortable -

getMultivalued

public Boolean getMultivalued()

Get the 'multivalued' element value. Indicates if the field may contain multiple values. Some query engines such as SOLR support this capability.

Returns:

value

setMultivalued

public void setMultivalued(Boolean multivalued)

Set the 'multivalued' element value. Indicates if the field may contain multiple values. Some query engines such as SOLR support this capability.

Parameters:

multivalued -