org.elasticsearch.script

Class Template

java.lang.Object

org.elasticsearch.script.Script

org.elasticsearch.script.Template

All Implemented Interfaces:

Writeable, ToXContent

public class Template
extends Script

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.script.Script

Script.ScriptField, Script.ScriptParseException

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

Writeable.Reader<R>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_LANG Default templating language

Fields inherited from class org.elasticsearch.script.Script

DEFAULT_TYPE

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Template(StreamInput in)
Template(java.lang.String template) Constructor for simple inline template.
Template(java.lang.String template, ScriptService.ScriptType type, java.lang.String lang, XContentType xContentType, java.util.Map<java.lang.String,java.lang.Object> params) Constructor for Template.

Method Summary

Modifier and Type	Method and Description
protected void	doWriteTo(StreamOutput out)
boolean	equals(java.lang.Object obj)
XContentType	getContentType() Method for getting the XContentType of the template.
int	hashCode()
static Script	parse(java.util.Map<java.lang.String,java.lang.Object> config, boolean removeMatchedEntries, ParseFieldMatcher parseFieldMatcher)
static Template	parse(XContentParser parser, java.util.Map<java.lang.String,ScriptService.ScriptType> additionalTemplateFieldNames, ParseFieldMatcher parseFieldMatcher) Deprecated.
static Template	parse(XContentParser parser, java.util.Map<java.lang.String,ScriptService.ScriptType> additionalTemplateFieldNames, java.lang.String defaultLang, ParseFieldMatcher parseFieldMatcher) Deprecated.
static Template	parse(XContentParser parser, ParseFieldMatcher parseFieldMatcher)
protected XContentBuilder	scriptFieldToXContent(java.lang.String template, ScriptService.ScriptType type, XContentBuilder builder, ToXContent.Params builderParams)

Methods inherited from class org.elasticsearch.script.Script

getLang, getParams, getScript, getType, toString, toXContent, writeTo

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LANG

public static final java.lang.String DEFAULT_LANG

Default templating language

See Also:

Constant Field Values

Constructor Detail

Template

public Template(java.lang.String template)

Constructor for simple inline template. The template will have no lang, content type or params set.

Parameters:

template - The inline template.

Template

public Template(java.lang.String template,
                ScriptService.ScriptType type,
                @Nullable
                java.lang.String lang,
                @Nullable
                XContentType xContentType,
                @Nullable
                java.util.Map<java.lang.String,java.lang.Object> params)

Constructor for Template.

Parameters:

template - The cache key of the template to be compiled/executed. For inline templates this is the actual templates source code. For indexed templates this is the id used in the request. For on file templates this is the file name.

type - The type of template -- dynamic, indexed, or file.

lang - The language of the template to be compiled/executed.

xContentType - The XContentType of the template.

params - The map of parameters the template will be executed with.

Template

public Template(StreamInput in)
         throws java.io.IOException

Throws:

java.io.IOException

Method Detail

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Overrides:

doWriteTo in class Script

Throws:

java.io.IOException

getContentType

public XContentType getContentType()

Method for getting the XContentType of the template.

Returns:

The XContentType of the template.

scriptFieldToXContent

protected XContentBuilder scriptFieldToXContent(java.lang.String template,
                                                ScriptService.ScriptType type,
                                                XContentBuilder builder,
                                                ToXContent.Params builderParams)
                                         throws java.io.IOException

Overrides:

scriptFieldToXContent in class Script

Throws:

java.io.IOException

parse

public static Script parse(java.util.Map<java.lang.String,java.lang.Object> config,
                           boolean removeMatchedEntries,
                           ParseFieldMatcher parseFieldMatcher)

parse

public static Template parse(XContentParser parser,
                             ParseFieldMatcher parseFieldMatcher)
                      throws java.io.IOException

Throws:

java.io.IOException

parse

@Deprecated
public static Template parse(XContentParser parser,
                                         java.util.Map<java.lang.String,ScriptService.ScriptType> additionalTemplateFieldNames,
                                         ParseFieldMatcher parseFieldMatcher)
                                  throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

parse

@Deprecated
public static Template parse(XContentParser parser,
                                         java.util.Map<java.lang.String,ScriptService.ScriptType> additionalTemplateFieldNames,
                                         java.lang.String defaultLang,
                                         ParseFieldMatcher parseFieldMatcher)
                                  throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Script

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Script