org.elasticsearch.action.termvector

Class TermVectorRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

org.elasticsearch.action.support.single.shard.SingleShardOperationRequest<TermVectorRequest>

org.elasticsearch.action.termvector.TermVectorRequest

All Implemented Interfaces:

DocumentRequest<TermVectorRequest>, IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class TermVectorRequest
extends SingleShardOperationRequest<TermVectorRequest>
implements DocumentRequest<TermVectorRequest>

Request returning the term vector (doc frequency, positions, offsets) for a document.

Note, the SingleShardOperationRequest.index(), type(String) and id(String) are required.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TermVectorRequest.Flag

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Field Summary

Fields

Modifier and Type	Field and Description
protected String	preference

Fields inherited from class org.elasticsearch.action.support.single.shard.SingleShardOperationRequest

index, INDICES_OPTIONS

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
TermVectorRequest()
TermVectorRequest(MultiGetRequest.Item item)
TermVectorRequest(String index, String type, String id) Constructs a new term vector request for a document that will be fetch from the provided index.
TermVectorRequest(TermVectorRequest other) Constructs a new term vector request for a document that will be fetch from the provided index.

Method Summary

Modifier and Type	Method and Description
BytesReference	doc() Returns the artificial document from which term vectors are requested for.
TermVectorRequest	doc(BytesReference doc, boolean generateRandomId) Sets an artificial document from which term vectors are requested for.
TermVectorRequest	doc(XContentBuilder documentBuilder) Sets an artificial document from which term vectors are requested for.
boolean	fieldStatistics()
TermVectorRequest	fieldStatistics(boolean fieldStatistics) Return the field statistics for each term in the shard or skip.
EnumSet<TermVectorRequest.Flag>	getFlags()
String	id() Returns the id of document the term vector is requested for.
TermVectorRequest	id(String id) Sets the id of document the term vector is requested for.
boolean	offsets()
TermVectorRequest	offsets(boolean offsets) Return the start and stop offsets for each term if they were stored or skip offsets.
TermVectorRequest	parent(String parent) Sets the parent id of this document.
static void	parseRequest(TermVectorRequest termVectorRequest, XContentParser parser) populates a request object (pre-populated with defaults) based on a parser.
boolean	payloads()
TermVectorRequest	payloads(boolean payloads) Return the payloads for each term or skip.
Map<String,String>	perFieldAnalyzer() Return the overridden analyzers at each field
TermVectorRequest	perFieldAnalyzer(Map<String,String> perFieldAnalyzer) Override the analyzer used at each field when generating term vectors
boolean	positions()
TermVectorRequest	positions(boolean positions) Return the positions for each term if stored or skip.
String	preference()
TermVectorRequest	preference(String preference) Sets the preference to execute the search.
void	readFrom(StreamInput in)
static TermVectorRequest	readTermVectorRequest(StreamInput in)
boolean	realtime()
TermVectorRequest	realtime(Boolean realtime)
String	routing() Get the routing for this request
TermVectorRequest	routing(String routing) Set the routing for this request
Set<String>	selectedFields() Return only term vectors for special selected fields.
TermVectorRequest	selectedFields(String... fields) Return only term vectors for special selected fields.
long	startTime()
boolean	termStatistics()
TermVectorRequest	termStatistics(boolean termStatistics) Return the term statistics for each term in the shard or skip.
String	type() Returns the type of document to get the term vector for.
TermVectorRequest	type(String type) Sets the type of document to get the term vector for.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.single.shard.SingleShardOperationRequest

index, index, indices, indicesOptions, operationThreaded, operationThreaded

Methods inherited from class org.elasticsearch.action.ActionRequest

listenerThreaded, listenerThreaded

Methods inherited from class org.elasticsearch.transport.TransportMessage

putHeader, remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putInContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.DocumentRequest

index, indicesOptions

Field Detail

preference

protected String preference

Constructor Detail

TermVectorRequest

public TermVectorRequest()

TermVectorRequest

public TermVectorRequest(String index,
                         String type,
                         String id)

Constructs a new term vector request for a document that will be fetch from the provided index. Use type(String) and id(String) to specify the document to load.

TermVectorRequest

public TermVectorRequest(TermVectorRequest other)

Constructs a new term vector request for a document that will be fetch from the provided index. Use type(String) and id(String) to specify the document to load.

TermVectorRequest

public TermVectorRequest(MultiGetRequest.Item item)

Method Detail

getFlags

public EnumSet<TermVectorRequest.Flag> getFlags()

type

public TermVectorRequest type(String type)

Sets the type of document to get the term vector for.

type

public String type()

Returns the type of document to get the term vector for.

Specified by:

type in interface DocumentRequest<TermVectorRequest>

Returns:

the type

id

public String id()

Returns the id of document the term vector is requested for.

Specified by:

id in interface DocumentRequest<TermVectorRequest>

Returns:

the id

id

public TermVectorRequest id(String id)

Sets the id of document the term vector is requested for.

doc

public BytesReference doc()

Returns the artificial document from which term vectors are requested for.

doc

public TermVectorRequest doc(XContentBuilder documentBuilder)

Sets an artificial document from which term vectors are requested for.

doc

public TermVectorRequest doc(BytesReference doc,
                             boolean generateRandomId)

Sets an artificial document from which term vectors are requested for.

routing

public String routing()

Description copied from interface: DocumentRequest

Get the routing for this request

Specified by:

routing in interface DocumentRequest<TermVectorRequest>

Returns:

The routing for this request.

routing

public TermVectorRequest routing(String routing)

Description copied from interface: DocumentRequest

Set the routing for this request

Specified by:

routing in interface DocumentRequest<TermVectorRequest>

Returns:

the Request

parent

public TermVectorRequest parent(String parent)

Sets the parent id of this document. Will simply set the routing to this value, as it is only used for routing with delete requests.

preference

public String preference()

preference

public TermVectorRequest preference(String preference)

Sets the preference to execute the search. Defaults to randomize across shards. Can be set to _local to prefer local shards, _primary to execute only on primary shards, or a custom value, which guarantees that the same order will be used across different requests.

offsets

public TermVectorRequest offsets(boolean offsets)

Return the start and stop offsets for each term if they were stored or skip offsets.

offsets

public boolean offsets()

Returns:

true if term offsets should be returned. Otherwise false

positions

public TermVectorRequest positions(boolean positions)

Return the positions for each term if stored or skip.

positions

public boolean positions()

Returns:

Returns if the positions for each term should be returned if stored or skip.

payloads

public boolean payloads()

Returns:

true if term payloads should be returned. Otherwise false

payloads

public TermVectorRequest payloads(boolean payloads)

Return the payloads for each term or skip.

termStatistics

public boolean termStatistics()

Returns:

true if term statistics should be returned. Otherwise false

termStatistics

public TermVectorRequest termStatistics(boolean termStatistics)

Return the term statistics for each term in the shard or skip.

fieldStatistics

public boolean fieldStatistics()

Returns:

true if field statistics should be returned. Otherwise false

fieldStatistics

public TermVectorRequest fieldStatistics(boolean fieldStatistics)

Return the field statistics for each term in the shard or skip.

selectedFields

public Set<String> selectedFields()

Return only term vectors for special selected fields. Returns for term vectors for all fields if selectedFields == null

selectedFields

public TermVectorRequest selectedFields(String... fields)

Return only term vectors for special selected fields. Returns the term vectors for all fields if selectedFields == null

realtime

public boolean realtime()

realtime

public TermVectorRequest realtime(Boolean realtime)

perFieldAnalyzer

public Map<String,String> perFieldAnalyzer()

Return the overridden analyzers at each field

perFieldAnalyzer

public TermVectorRequest perFieldAnalyzer(Map<String,String> perFieldAnalyzer)

Override the analyzer used at each field when generating term vectors

startTime

public long startTime()

validate

public ActionRequestValidationException validate()

Overrides:

validate in class SingleShardOperationRequest<TermVectorRequest>

readTermVectorRequest

public static TermVectorRequest readTermVectorRequest(StreamInput in)
                                               throws IOException

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class SingleShardOperationRequest<TermVectorRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class SingleShardOperationRequest<TermVectorRequest>

Throws:

IOException

parseRequest

public static void parseRequest(TermVectorRequest termVectorRequest,
                                XContentParser parser)
                         throws IOException

populates a request object (pre-populated with defaults) based on a parser.

Throws:

IOException