Module org.elasticsearch.server

Package org.elasticsearch.synonyms

Class SynonymRule

java.lang.Object

org.elasticsearch.synonyms.SynonymRule

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class SynonymRule
extends Object
implements Writeable, ToXContentObject

Nested Class Summary

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

Modifier and Type	Field	Description
static final ParseField	ID_FIELD
static final ParseField	SYNONYMS_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SynonymRule(String id, String synonyms)
SynonymRule(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static SynonymRule	fromXContent(XContentParser parser)
int	hashCode()
String	id()
String	synonyms()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
String	validate()	A simple validation of a synonym rule outside of the context of a specific analyzer.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

SYNONYMS_FIELD

public static final ParseField SYNONYMS_FIELD

ID_FIELD

public static final ParseField ID_FIELD

Constructor Details

SynonymRule

public SynonymRule(@Nullable
 String id,
 String synonyms)

SynonymRule

public SynonymRule(StreamInput in)
            throws IOException

Throws:

IOException

Method Details

fromXContent

public static SynonymRule fromXContent(XContentParser parser)

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

synonyms

public String synonyms()

id

public String id()

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

validate

public String validate()

A simple validation of a synonym rule outside of the context of a specific analyzer. Adopted from org.apache.lucene.analysis.synonym.SolrSynonymParser, with modifications not to invoke analyze method.

Returns:

null if the synonym rule is valid, otherwise return the error message.