Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Class View

java.lang.Object

org.elasticsearch.cluster.metadata.View

All Implemented Interfaces:

IndexAbstraction, Writeable, ToXContent, ToXContentObject

public final class View
extends Object
implements Writeable, ToXContentObject, IndexAbstraction

Represents a single view definition, which is simply a name and a query string.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.cluster.metadata.IndexAbstraction

IndexAbstraction.Alias, IndexAbstraction.ConcreteIndex, IndexAbstraction.Type

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
View(String name, String query)
View(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static View	fromXContent(XContentParser parser)
List<Index>	getIndices()
String	getName()
DataStream	getParentDataStream()
IndexAbstraction.Type	getType()
Index	getWriteIndex()	A write index is a dedicated concrete index, that accepts all the new documents that belong to an index abstraction.
int	hashCode()
boolean	isHidden()
boolean	isSystem()
String	name()
static ConstructingObjectParser<View,Void>	parser(String name)
String	query()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.cluster.metadata.IndexAbstraction

getFailureIndices, getWriteFailureIndex, getWriteIndex, isDataStreamRelated, isFailureIndexOfDataStream

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

View

public View(String name,
 String query)

View

public View(StreamInput in)
     throws IOException

Throws:

IOException

Method Details

parser

public static ConstructingObjectParser<View,Void> parser(String name)

fromXContent

public static View fromXContent(XContentParser parser)
                         throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

name

public String name()

query

public String query()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getType

public IndexAbstraction.Type getType()

Specified by:

getType in interface IndexAbstraction

Returns:

the type of the index abstraction

getName

public String getName()

Specified by:

getName in interface IndexAbstraction

Returns:

the name of the index abstraction

getIndices

public List<Index> getIndices()

Specified by:

getIndices in interface IndexAbstraction

Returns:

All Index of all concrete indices this index abstraction is referring to.

getWriteIndex

public Index getWriteIndex()

Description copied from interface: IndexAbstraction

A write index is a dedicated concrete index, that accepts all the new documents that belong to an index abstraction.

A write index may also be a regular concrete index of a index abstraction and may therefore also be returned by IndexAbstraction.getIndices(). An index abstraction may also not have a dedicated write index.

Specified by:

getWriteIndex in interface IndexAbstraction

Returns:

the write index of this index abstraction or null if this index abstraction doesn't have a write index.

getParentDataStream

public DataStream getParentDataStream()

Specified by:

getParentDataStream in interface IndexAbstraction

Returns:

the data stream to which this index belongs or null if this is not a concrete index or if it is a concrete index that does not belong to a data stream.

isHidden

public boolean isHidden()

Specified by:

isHidden in interface IndexAbstraction

Returns:

whether this index abstraction is hidden or not

isSystem

public boolean isSystem()

Specified by:

isSystem in interface IndexAbstraction

Returns:

whether this index abstraction should be treated as a system index or not