org.elasticsearch.action.termvectors

Class TermVectorsRequest

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.SingleShardRequest<TermVectorsRequest>

org.elasticsearch.action.termvectors.TermVectorsRequest

All Implemented Interfaces:

DocumentRequest<TermVectorsRequest>, IndicesRequest, RealtimeRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class TermVectorsRequest
extends SingleShardRequest<TermVectorsRequest>
implements DocumentRequest<TermVectorsRequest>, RealtimeRequest

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TermVectorsRequest.FilterSettings
static class	TermVectorsRequest.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.SingleShardRequest

index, INDICES_OPTIONS

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	dfs()
TermVectorsRequest	dfs(boolean dfs) Use distributed frequencies instead of shard statistics.
BytesReference	doc() Returns the artificial document from which term vectors are requested for.
TermVectorsRequest	doc(BytesReference doc, boolean generateRandomId) Sets an artificial document from which term vectors are requested for.
TermVectorsRequest	doc(XContentBuilder documentBuilder) Sets an artificial document from which term vectors are requested for.
boolean	fieldStatistics()
TermVectorsRequest	fieldStatistics(boolean fieldStatistics) Return the field statistics for each term in the shard or skip.
TermVectorsRequest.FilterSettings	filterSettings() Return the settings for filtering out terms.
TermVectorsRequest	filterSettings(TermVectorsRequest.FilterSettings settings) Sets the settings for filtering out terms.
EnumSet<TermVectorsRequest.Flag>	getFlags()
String	id() Returns the id of document the term vector is requested for.
TermVectorsRequest	id(String id) Sets the id of document the term vector is requested for.
boolean	offsets()
TermVectorsRequest	offsets(boolean offsets) Return the start and stop offsets for each term if they were stored or skip offsets.
TermVectorsRequest	parent(String parent) Sets the parent id of this document.
static void	parseRequest(TermVectorsRequest termVectorsRequest, XContentParser parser) populates a request object (pre-populated with defaults) based on a parser.
boolean	payloads()
TermVectorsRequest	payloads(boolean payloads) Return the payloads for each term or skip.
Map<String,String>	perFieldAnalyzer() Return the overridden analyzers at each field.
TermVectorsRequest	perFieldAnalyzer(Map<String,String> perFieldAnalyzer) Override the analyzer used at each field when generating term vectors.
boolean	positions()
TermVectorsRequest	positions(boolean positions) Return the positions for each term if stored or skip.
String	preference()
TermVectorsRequest	preference(String preference) Sets the preference to execute the search.
void	readFrom(StreamInput in)
static Map<String,String>	readPerFieldAnalyzer(Map<String,Object> map)
static TermVectorsRequest	readTermVectorsRequest(StreamInput in)
boolean	realtime() Return whether term vectors should be generated real-time (default to true).
TermVectorsRequest	realtime(Boolean realtime) Choose whether term vectors be generated real-time.
String	routing() Get the routing for this request
TermVectorsRequest	routing(String routing) Set the routing for this request
Set<String>	selectedFields() Return only term vectors for special selected fields.
TermVectorsRequest	selectedFields(String... fields) Return only term vectors for special selected fields.
long	startTime()
boolean	termStatistics()
TermVectorsRequest	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.
TermVectorsRequest	type(String type) Sets the type of document to get the term vector for.
ActionRequestValidationException	validate()
long	version()
TermVectorsRequest	version(long version)
VersionType	versionType()
TermVectorsRequest	versionType(VersionType versionType)
void	writeTo(StreamOutput out)

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

index, index, indices, indicesOptions, operationThreaded, operationThreaded, validateNonNullIndex

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, 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

Methods inherited from interface org.elasticsearch.action.IndicesRequest

indices

Field Detail

preference

protected String preference

Constructor Detail

TermVectorsRequest

public TermVectorsRequest()

TermVectorsRequest

public TermVectorsRequest(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.

TermVectorsRequest

public TermVectorsRequest(TermVectorsRequest 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.

TermVectorsRequest

public TermVectorsRequest(MultiGetRequest.Item item)

Method Detail

getFlags

public EnumSet<TermVectorsRequest.Flag> getFlags()

type

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

Returns:

the type

id

public String id()

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

Specified by:

id in interface DocumentRequest<TermVectorsRequest>

Returns:

the id

id

public TermVectorsRequest 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 TermVectorsRequest doc(XContentBuilder documentBuilder)

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

doc

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

Returns:

The routing for this request.

routing

public TermVectorsRequest routing(String routing)

Description copied from interface: DocumentRequest

Set the routing for this request

Specified by:

routing in interface DocumentRequest<TermVectorsRequest>

Returns:

the Request

parent

public TermVectorsRequest 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 TermVectorsRequest 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 TermVectorsRequest 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 TermVectorsRequest 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 TermVectorsRequest 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 TermVectorsRequest 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 TermVectorsRequest fieldStatistics(boolean fieldStatistics)

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

dfs

public boolean dfs()

Returns:

true if distributed frequencies should be returned. Otherwise false

dfs

public TermVectorsRequest dfs(boolean dfs)

Use distributed frequencies instead of shard statistics.

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 TermVectorsRequest 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()

Return whether term vectors should be generated real-time (default to true).

realtime

public TermVectorsRequest realtime(Boolean realtime)

Choose whether term vectors be generated real-time.

Specified by:

realtime in interface RealtimeRequest

Parameters:

realtime - Controls whether this request should be realtime by reading from the translog. If null is specified then whether the operation will be realtime depends on the api of the concrete request subclass.

perFieldAnalyzer

public Map<String,String> perFieldAnalyzer()

Return the overridden analyzers at each field.

perFieldAnalyzer

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

Override the analyzer used at each field when generating term vectors.

filterSettings

public TermVectorsRequest.FilterSettings filterSettings()

Return the settings for filtering out terms.

filterSettings

public TermVectorsRequest filterSettings(TermVectorsRequest.FilterSettings settings)

Sets the settings for filtering out terms.

version

public long version()

version

public TermVectorsRequest version(long version)

versionType

public VersionType versionType()

versionType

public TermVectorsRequest versionType(VersionType versionType)

startTime

public long startTime()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<TermVectorsRequest>

readTermVectorsRequest

public static TermVectorsRequest readTermVectorsRequest(StreamInput in)
                                                 throws IOException

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class SingleShardRequest<TermVectorsRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class SingleShardRequest<TermVectorsRequest>

Throws:

IOException

parseRequest

public static void parseRequest(TermVectorsRequest termVectorsRequest,
                XContentParser parser)
                         throws IOException

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

Throws:

IOException

readPerFieldAnalyzer

public static Map<String,String> readPerFieldAnalyzer(Map<String,Object> map)