BaseInnerHitBuilder (Elasticsearch: Core 2.3.5.1 API)

java.lang.Object
- org.elasticsearch.index.query.support.BaseInnerHitBuilder<T>

すべての実装されたインタフェース:

ToXContent

直系の既知のサブクラス:

InnerHitsBuilder.InnerHit, QueryInnerHitBuilder
```
public abstract class BaseInnerHitBuilder<T extends BaseInnerHitBuilder>
extends Object
implements ToXContent
```

ネストされたクラスのサマリー
- インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.xcontent.ToXContent
  ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

protected SearchSourceBuilder sourceBuilder
- インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent
  EMPTY_PARAMS

フィールド
修飾子とタイプ	フィールドと説明
`protected SearchSourceBuilder`	`sourceBuilder`

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

BaseInnerHitBuilder()

コンストラクタ
コンストラクタと説明
`BaseInnerHitBuilder()`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`T`	`addFieldDataField(String name)` Adds a field data based field to load and return.
`T`	`addHighlightedField(HighlightBuilder.Field field)` Adds a highlighted field.
`T`	`addHighlightedField(String name)` Adds a field to be highlighted with default fragment size of 100 characters, and default number of fragments of 5.
`T`	`addHighlightedField(String name, int fragmentSize)` Adds a field to be highlighted with a provided fragment size (in characters), and default number of fragments of 5.
`T`	`addHighlightedField(String name, int fragmentSize, int numberOfFragments)` Adds a field to be highlighted with a provided fragment size (in characters), and a provided (maximum) number of fragments.
`T`	`addHighlightedField(String name, int fragmentSize, int numberOfFragments, int fragmentOffset)` Adds a field to be highlighted with a provided fragment size (in characters), a provided (maximum) number of fragments and an offset for the highlight.
`T`	`addScriptField(String name, Script script)` Adds a script based field to load and return.
`T`	`addSort(SortBuilder sort)` Adds a generic sort builder.
`T`	`addSort(String field, SortOrder order)` Adds a sort against the given field name and the sort ordering.
`T`	`field(String name)` Add a stored field to be loaded and returned with the inner hit.
`HighlightBuilder`	`highlightBuilder()`
`T`	`setExplain(boolean explain)` Should each `SearchHit` be returned with an explanation of the hit (ranking).
`T`	`setFetchSource(boolean fetch)` Indicates whether the response should contain the stored _source for every hit
`T`	`setFetchSource(String[] includes, String[] excludes)` Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.
`T`	`setFetchSource(String include, String exclude)` Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.
`T`	`setFrom(int from)` The index to start to return hits from.
`T`	`setHighlighterBoundaryChars(char[] boundaryChars)`
`T`	`setHighlighterBoundaryMaxScan(Integer boundaryMaxScan)`
`T`	`setHighlighterEncoder(String encoder)` The encoder to set for highlighting
`T`	`setHighlighterFilter(Boolean highlightFilter)`
`T`	`setHighlighterFragmenter(String fragmenter)`
`T`	`setHighlighterFragmentSize(Integer fragmentSize)`
`T`	`setHighlighterNoMatchSize(Integer noMatchSize)` Sets the size of the fragment to return from the beginning of the field if there are no matches to highlight and the field doesn't also define noMatchSize.
`T`	`setHighlighterNumOfFragments(Integer numOfFragments)`
`T`	`setHighlighterOptions(Map<String,Object> options)`
`T`	`setHighlighterOrder(String order)` The order of fragments per field.
`T`	`setHighlighterPhraseLimit(Integer phraseLimit)` Sets the maximum number of phrases the fvh will consider if the field doesn't also define phraseLimit.
`T`	`setHighlighterPostTags(String... postTags)` Explicitly set the post tags that will be used for highlighting.
`T`	`setHighlighterPreTags(String... preTags)` Explicitly set the pre tags that will be used for highlighting.
`T`	`setHighlighterQuery(QueryBuilder highlightQuery)` Sets a query to be used for highlighting all fields instead of the search query.
`T`	`setHighlighterRequireFieldMatch(boolean requireFieldMatch)`
`T`	`setHighlighterTagsSchema(String schemaName)` Set a tag scheme that encapsulates a built in pre and post tags.
`T`	`setHighlighterType(String type)` The highlighter type to use.
`T`	`setNoFields()` Sets no fields to be loaded, resulting in only id and type to be returned per field.
`T`	`setSize(int size)` The number of search hits to return.
`T`	`setTrackScores(boolean trackScores)` Applies when sorting, and controls if scores will be tracked as well.
`T`	`setVersion(boolean version)` Should each `SearchHit` be returned with its version.
`protected SearchSourceBuilder`	`sourceBuilder()`
`XContentBuilder`	`toXContent(XContentBuilder builder, ToXContent.Params params)`

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - sourceBuilder
```
protected SearchSourceBuilder sourceBuilder
```
- コンストラクタの詳細
  - BaseInnerHitBuilder
```
public BaseInnerHitBuilder()
```
- メソッドの詳細
  - setFrom
```
public T setFrom(int from)
```
    The index to start to return hits from. Defaults to 0.
  - setSize
```
public T setSize(int size)
```
    The number of search hits to return. Defaults to 10.
  - setTrackScores
```
public T setTrackScores(boolean trackScores)
```
    Applies when sorting, and controls if scores will be tracked as well. Defaults to false.
  - setExplain
```
public T setExplain(boolean explain)
```
    Should each SearchHit be returned with an explanation of the hit (ranking).
  - setVersion
```
public T setVersion(boolean version)
```
    Should each SearchHit be returned with its version.
  - field
```
public T field(String name)
```
    Add a stored field to be loaded and returned with the inner hit.
  - setNoFields
```
public T setNoFields()
```
    Sets no fields to be loaded, resulting in only id and type to be returned per field.
  - setFetchSource
```
public T setFetchSource(boolean fetch)
```
    Indicates whether the response should contain the stored _source for every hit
  - setFetchSource
```
public T setFetchSource(@Nullable
                        String include,
                        @Nullable
                        String exclude)
```
    Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.
    
    パラメータ:
    
    include - An optional include (optionally wildcarded) pattern to filter the returned _source
    
    exclude - An optional exclude (optionally wildcarded) pattern to filter the returned _source
  - setFetchSource
```
public T setFetchSource(@Nullable
                        String[] includes,
                        @Nullable
                        String[] excludes)
```
    Indicate that _source should be returned with every hit, with an "include" and/or "exclude" set which can include simple wildcard elements.
    
    パラメータ:
    
    includes - An optional list of include (optionally wildcarded) pattern to filter the returned _source
    
    excludes - An optional list of exclude (optionally wildcarded) pattern to filter the returned _source
  - addFieldDataField
```
public T addFieldDataField(String name)
```
    Adds a field data based field to load and return. The field does not have to be stored, but its recommended to use non analyzed or numeric fields.
    
    パラメータ:
    
    name - The field to get from the field data cache
  - addScriptField
```
public T addScriptField(String name,
                        Script script)
```
    Adds a script based field to load and return. The field does not have to be stored, but its recommended to use non analyzed or numeric fields.
    
    パラメータ:
    
    name - The name that will represent this value in the return hit
    
    script - The script to use
  - addSort
```
public T addSort(String field,
                 SortOrder order)
```
    Adds a sort against the given field name and the sort ordering.
    
    パラメータ:
    
    field - The name of the field
    
    order - The sort ordering
  - addSort
```
public T addSort(SortBuilder sort)
```
    Adds a generic sort builder.
    
    関連項目:
    
    SortBuilders
  - highlightBuilder
```
public HighlightBuilder highlightBuilder()
```
  - addHighlightedField
```
public T addHighlightedField(String name)
```
    Adds a field to be highlighted with default fragment size of 100 characters, and default number of fragments of 5.
    
    パラメータ:
    
    name - The field to highlight
  - addHighlightedField
```
public T addHighlightedField(String name,
                             int fragmentSize)
```
    Adds a field to be highlighted with a provided fragment size (in characters), and default number of fragments of 5.
    
    パラメータ:
    
    name - The field to highlight
    
    fragmentSize - The size of a fragment in characters
  - addHighlightedField
```
public T addHighlightedField(String name,
                             int fragmentSize,
                             int numberOfFragments)
```
    Adds a field to be highlighted with a provided fragment size (in characters), and a provided (maximum) number of fragments.
    
    パラメータ:
    
    name - The field to highlight
    
    fragmentSize - The size of a fragment in characters
    
    numberOfFragments - The (maximum) number of fragments
  - addHighlightedField
```
public T addHighlightedField(String name,
                             int fragmentSize,
                             int numberOfFragments,
                             int fragmentOffset)
```
    Adds a field to be highlighted with a provided fragment size (in characters), a provided (maximum) number of fragments and an offset for the highlight.
    
    パラメータ:
    
    name - The field to highlight
    
    fragmentSize - The size of a fragment in characters
    
    numberOfFragments - The (maximum) number of fragments
  - addHighlightedField
```
public T addHighlightedField(HighlightBuilder.Field field)
```
    Adds a highlighted field.
  - setHighlighterTagsSchema
```
public T setHighlighterTagsSchema(String schemaName)
```
    Set a tag scheme that encapsulates a built in pre and post tags. The allows schemes are styled and default.
    
    パラメータ:
    
    schemaName - The tag scheme name
  - setHighlighterFragmentSize
```
public T setHighlighterFragmentSize(Integer fragmentSize)
```
  - setHighlighterNumOfFragments
```
public T setHighlighterNumOfFragments(Integer numOfFragments)
```
  - setHighlighterFilter
```
public T setHighlighterFilter(Boolean highlightFilter)
```
  - setHighlighterEncoder
```
public T setHighlighterEncoder(String encoder)
```
    The encoder to set for highlighting
  - setHighlighterPreTags
```
public T setHighlighterPreTags(String... preTags)
```
    Explicitly set the pre tags that will be used for highlighting.
  - setHighlighterPostTags
```
public T setHighlighterPostTags(String... postTags)
```
    Explicitly set the post tags that will be used for highlighting.
  - setHighlighterOrder
```
public T setHighlighterOrder(String order)
```
    The order of fragments per field. By default, ordered by the order in the highlighted text. Can be score, which then it will be ordered by score of the fragments.
  - setHighlighterRequireFieldMatch
```
public T setHighlighterRequireFieldMatch(boolean requireFieldMatch)
```
  - setHighlighterBoundaryMaxScan
```
public T setHighlighterBoundaryMaxScan(Integer boundaryMaxScan)
```
  - setHighlighterBoundaryChars
```
public T setHighlighterBoundaryChars(char[] boundaryChars)
```
  - setHighlighterType
```
public T setHighlighterType(String type)
```
    The highlighter type to use.
  - setHighlighterFragmenter
```
public T setHighlighterFragmenter(String fragmenter)
```
  - setHighlighterQuery
```
public T setHighlighterQuery(QueryBuilder highlightQuery)
```
    Sets a query to be used for highlighting all fields instead of the search query.
  - setHighlighterNoMatchSize
```
public T setHighlighterNoMatchSize(Integer noMatchSize)
```
    Sets the size of the fragment to return from the beginning of the field if there are no matches to highlight and the field doesn't also define noMatchSize.
    
    パラメータ:
    
    noMatchSize - integer to set or null to leave out of request. default is null.
    
    戻り値:
    
    this builder for chaining
  - setHighlighterPhraseLimit
```
public T setHighlighterPhraseLimit(Integer phraseLimit)
```
    Sets the maximum number of phrases the fvh will consider if the field doesn't also define phraseLimit.
  - setHighlighterOptions
```
public T setHighlighterOptions(Map<String,Object> options)
```
  - sourceBuilder
```
protected SearchSourceBuilder sourceBuilder()
```
  - toXContent
```
public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException
```
    定義:
    
    toXContent インタフェース内 ToXContent
    
    例外:
    
    IOException

クラス BaseInnerHitBuilder<T extends BaseInnerHitBuilder>

ネストされたクラスのサマリー

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.xcontent.ToXContent

フィールドのサマリー

インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

sourceBuilder

コンストラクタの詳細

BaseInnerHitBuilder

メソッドの詳細

setFrom

setSize

setTrackScores

setExplain

setVersion

field

setNoFields

setFetchSource

setFetchSource

setFetchSource

addFieldDataField

addScriptField

addSort

addSort

highlightBuilder

addHighlightedField

addHighlightedField

addHighlightedField

addHighlightedField

addHighlightedField

setHighlighterTagsSchema

setHighlighterFragmentSize

setHighlighterNumOfFragments

setHighlighterFilter

setHighlighterEncoder

setHighlighterPreTags

setHighlighterPostTags

setHighlighterOrder

setHighlighterRequireFieldMatch

setHighlighterBoundaryMaxScan

setHighlighterBoundaryChars

setHighlighterType

setHighlighterFragmenter

setHighlighterQuery

setHighlighterNoMatchSize

setHighlighterPhraseLimit

setHighlighterOptions

sourceBuilder

toXContent