InternalSearchHit (Elasticsearch: Core 2.3.5.1 API)

java.lang.Object
- org.elasticsearch.search.internal.InternalSearchHit

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

Iterable<SearchHitField>, Streamable, ToXContent, SearchHit
```
public class InternalSearchHit
extends Object
implements SearchHit
```

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

ネストされたクラス
修飾子とタイプクラスと説明

static class InternalSearchHit.Fields

static class InternalSearchHit.InternalNestedIdentity
- インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.search.SearchHit
  SearchHit.NestedIdentity
- インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.xcontent.ToXContent
  ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`InternalSearchHit.Fields`
`static class`	`InternalSearchHit.InternalNestedIdentity`

フィールドのサマリー
- インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent
  EMPTY_PARAMS

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

コンストラクタ
コンストラクタと説明
`InternalSearchHit(int nestedTopDocId, String id, Text type, InternalSearchHit.InternalNestedIdentity nestedIdentity, Map<String,SearchHitField> fields)`
`InternalSearchHit(int docId, String id, Text type, Map<String,SearchHitField> fields)`

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`int`	`docId()`
`org.apache.lucene.search.Explanation`	`explanation()` If enabled, the explanation of the search hit.
`void`	`explanation(org.apache.lucene.search.Explanation explanation)`
`SearchHitField`	`field(String fieldName)` The hit field matching the given field name.
`Map<String,SearchHitField>`	`fields()` A map of hit fields (from field name to hit fields) if additional fields were required to be loaded.
`void`	`fields(Map<String,SearchHitField> fields)`
`Map<String,SearchHitField>`	`fieldsOrNull()`
`org.apache.lucene.search.Explanation`	`getExplanation()` If enabled, the explanation of the search hit.
`Map<String,SearchHitField>`	`getFields()` A map of hit fields (from field name to hit fields) if additional fields were required to be loaded.
`Map<String,HighlightField>`	`getHighlightFields()` A map of highlighted fields.
`String`	`getId()` The id of the document.
`String`	`getIndex()` The index of the hit.
`Map<String,SearchHits>`	`getInnerHits()`
`String[]`	`getMatchedQueries()` The set of query and filter names the query matched with.
`SearchHit.NestedIdentity`	`getNestedIdentity()` If this is a nested hit then nested reference information is returned otherwise `null` is returned.
`float`	`getScore()` The score.
`SearchShardTarget`	`getShard()` The shard of the search hit.
`Object[]`	`getSortValues()` An array of the sort values used.
`Map<String,Object>`	`getSource()` The source of the document as a map (can be `null`).
`String`	`getSourceAsString()` The source of the document as string (can be `null`).
`BytesReference`	`getSourceRef()` Returns bytes reference, also un compress the source if needed.
`String`	`getType()` The type of the document.
`long`	`getVersion()` The version of the hit.
`Map<String,HighlightField>`	`highlightFields()` A map of highlighted fields.
`void`	`highlightFields(Map<String,HighlightField> highlightFields)`
`String`	`id()` The id of the document.
`String`	`index()` The index of the hit.
`Map<String,HighlightField>`	`internalHighlightFields()`
`BytesReference`	`internalSourceRef()` Internal source representation, might be compressed....
`boolean`	`isSourceEmpty()` Is the source empty (not available) or not.
`Iterator<SearchHitField>`	`iterator()`
`String[]`	`matchedQueries()` The set of query and filter names the query matched with.
`void`	`matchedQueries(String[] matchedQueries)`
`void`	`readFrom(StreamInput in)`
`void`	`readFrom(StreamInput in, InternalSearchHits.StreamContext context)`
`static InternalSearchHit`	`readSearchHit(StreamInput in, InternalSearchHits.StreamContext context)`
`float`	`score()` The score.
`void`	`score(float score)`
`void`	`setInnerHits(Map<String,InternalSearchHits> innerHits)`
`SearchShardTarget`	`shard()` The shard of the search hit.
`void`	`shard(SearchShardTarget target)`
`void`	`shardTarget(SearchShardTarget shardTarget)`
`Object[]`	`sortValues()` An array of the sort values used.
`void`	`sortValues(Object[] sortValues)`
`byte[]`	`source()` The source of the document (can be `null`).
`Map<String,Object>`	`sourceAsMap()` The source of the document as a map (can be `null`).
`String`	`sourceAsString()` The source of the document as string (can be `null`).
`BytesReference`	`sourceRef()` Returns bytes reference, also un compress the source if needed.
`InternalSearchHit`	`sourceRef(BytesReference source)` Sets representation, might be compressed....
`XContentBuilder`	`toXContent(XContentBuilder builder, ToXContent.Params params)`
`String`	`type()` The type of the document.
`long`	`version()` The version of the hit.
`void`	`version(long version)`
`void`	`writeTo(StreamOutput out)`
`void`	`writeTo(StreamOutput out, InternalSearchHits.StreamContext context)`

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

インタフェースから継承されたメソッド java.lang.Iterable
forEach, spliterator

- コンストラクタの詳細
  - InternalSearchHit
```
public InternalSearchHit(int docId,
                         String id,
                         Text type,
                         Map<String,SearchHitField> fields)
```
  - InternalSearchHit
```
public InternalSearchHit(int nestedTopDocId,
                         String id,
                         Text type,
                         InternalSearchHit.InternalNestedIdentity nestedIdentity,
                         Map<String,SearchHitField> fields)
```
- メソッドの詳細
  - docId
```
public int docId()
```
  - shardTarget
```
public void shardTarget(SearchShardTarget shardTarget)
```
  - score
```
public void score(float score)
```
  - score
```
public float score()
```
    インタフェースからコピーされた説明: SearchHit
    
    The score.
    
    定義:
    
    score インタフェース内 SearchHit
  - getScore
```
public float getScore()
```
    インタフェースからコピーされた説明: SearchHit
    
    The score.
    
    定義:
    
    getScore インタフェース内 SearchHit
  - version
```
public void version(long version)
```
  - version
```
public long version()
```
    インタフェースからコピーされた説明: SearchHit
    
    The version of the hit.
    
    定義:
    
    version インタフェース内 SearchHit
  - getVersion
```
public long getVersion()
```
    インタフェースからコピーされた説明: SearchHit
    
    The version of the hit.
    
    定義:
    
    getVersion インタフェース内 SearchHit
  - index
```
public String index()
```
    インタフェースからコピーされた説明: SearchHit
    
    The index of the hit.
    
    定義:
    
    index インタフェース内 SearchHit
  - getIndex
```
public String getIndex()
```
    インタフェースからコピーされた説明: SearchHit
    
    The index of the hit.
    
    定義:
    
    getIndex インタフェース内 SearchHit
  - id
```
public String id()
```
    インタフェースからコピーされた説明: SearchHit
    
    The id of the document.
    
    定義:
    
    id インタフェース内 SearchHit
  - getId
```
public String getId()
```
    インタフェースからコピーされた説明: SearchHit
    
    The id of the document.
    
    定義:
    
    getId インタフェース内 SearchHit
  - type
```
public String type()
```
    インタフェースからコピーされた説明: SearchHit
    
    The type of the document.
    
    定義:
    
    type インタフェース内 SearchHit
  - getType
```
public String getType()
```
    インタフェースからコピーされた説明: SearchHit
    
    The type of the document.
    
    定義:
    
    getType インタフェース内 SearchHit
  - getNestedIdentity
```
public SearchHit.NestedIdentity getNestedIdentity()
```
    インタフェースからコピーされた説明: SearchHit
    
    If this is a nested hit then nested reference information is returned otherwise null is returned.
    
    定義:
    
    getNestedIdentity インタフェース内 SearchHit
  - sourceRef
```
public BytesReference sourceRef()
```
    Returns bytes reference, also un compress the source if needed.
    
    定義:
    
    sourceRef インタフェース内 SearchHit
  - sourceRef
```
public InternalSearchHit sourceRef(BytesReference source)
```
    Sets representation, might be compressed....
  - getSourceRef
```
public BytesReference getSourceRef()
```
    インタフェースからコピーされた説明: SearchHit
    
    Returns bytes reference, also un compress the source if needed.
    
    定義:
    
    getSourceRef インタフェース内 SearchHit
  - internalSourceRef
```
public BytesReference internalSourceRef()
```
    Internal source representation, might be compressed....
  - source
```
public byte[] source()
```
    インタフェースからコピーされた説明: SearchHit
    
    The source of the document (can be null). Note, its a copy of the source into a byte array, consider using SearchHit.sourceRef() so there won't be a need to copy.
    
    定義:
    
    source インタフェース内 SearchHit
  - isSourceEmpty
```
public boolean isSourceEmpty()
```
    インタフェースからコピーされた説明: SearchHit
    
    Is the source empty (not available) or not.
    
    定義:
    
    isSourceEmpty インタフェース内 SearchHit
  - getSource
```
public Map<String,Object> getSource()
```
    インタフェースからコピーされた説明: SearchHit
    
    The source of the document as a map (can be null).
    
    定義:
    
    getSource インタフェース内 SearchHit
  - sourceAsString
```
public String sourceAsString()
```
    インタフェースからコピーされた説明: SearchHit
    
    The source of the document as string (can be null).
    
    定義:
    
    sourceAsString インタフェース内 SearchHit
  - getSourceAsString
```
public String getSourceAsString()
```
    インタフェースからコピーされた説明: SearchHit
    
    The source of the document as string (can be null).
    
    定義:
    
    getSourceAsString インタフェース内 SearchHit
  - sourceAsMap
```
public Map<String,Object> sourceAsMap()
                               throws ElasticsearchParseException
```
    インタフェースからコピーされた説明: SearchHit
    
    The source of the document as a map (can be null).
    
    定義:
    
    sourceAsMap インタフェース内 SearchHit
    
    例外:
    
    ElasticsearchParseException
  - iterator
```
public Iterator<SearchHitField> iterator()
```
    定義:
    
    iterator インタフェース内 Iterable<SearchHitField>
  - field
```
public SearchHitField field(String fieldName)
```
    インタフェースからコピーされた説明: SearchHit
    
    The hit field matching the given field name.
    
    定義:
    
    field インタフェース内 SearchHit
  - fields
```
public Map<String,SearchHitField> fields()
```
    インタフェースからコピーされた説明: SearchHit
    
    A map of hit fields (from field name to hit fields) if additional fields were required to be loaded.
    
    定義:
    
    fields インタフェース内 SearchHit
  - fieldsOrNull
```
public Map<String,SearchHitField> fieldsOrNull()
```
  - getFields
```
public Map<String,SearchHitField> getFields()
```
    インタフェースからコピーされた説明: SearchHit
    
    A map of hit fields (from field name to hit fields) if additional fields were required to be loaded.
    
    定義:
    
    getFields インタフェース内 SearchHit
  - fields
```
public void fields(Map<String,SearchHitField> fields)
```
  - internalHighlightFields
```
public Map<String,HighlightField> internalHighlightFields()
```
  - highlightFields
```
public Map<String,HighlightField> highlightFields()
```
    インタフェースからコピーされた説明: SearchHit
    
    A map of highlighted fields.
    
    定義:
    
    highlightFields インタフェース内 SearchHit
  - getHighlightFields
```
public Map<String,HighlightField> getHighlightFields()
```
    インタフェースからコピーされた説明: SearchHit
    
    A map of highlighted fields.
    
    定義:
    
    getHighlightFields インタフェース内 SearchHit
  - highlightFields
```
public void highlightFields(Map<String,HighlightField> highlightFields)
```
  - sortValues
```
public void sortValues(Object[] sortValues)
```
  - sortValues
```
public Object[] sortValues()
```
    インタフェースからコピーされた説明: SearchHit
    
    An array of the sort values used.
    
    定義:
    
    sortValues インタフェース内 SearchHit
  - getSortValues
```
public Object[] getSortValues()
```
    インタフェースからコピーされた説明: SearchHit
    
    An array of the sort values used.
    
    定義:
    
    getSortValues インタフェース内 SearchHit
  - explanation
```
public org.apache.lucene.search.Explanation explanation()
```
    インタフェースからコピーされた説明: SearchHit
    
    If enabled, the explanation of the search hit.
    
    定義:
    
    explanation インタフェース内 SearchHit
  - getExplanation
```
public org.apache.lucene.search.Explanation getExplanation()
```
    インタフェースからコピーされた説明: SearchHit
    
    If enabled, the explanation of the search hit.
    
    定義:
    
    getExplanation インタフェース内 SearchHit
  - explanation
```
public void explanation(org.apache.lucene.search.Explanation explanation)
```
  - shard
```
public SearchShardTarget shard()
```
    インタフェースからコピーされた説明: SearchHit
    
    The shard of the search hit.
    
    定義:
    
    shard インタフェース内 SearchHit
  - getShard
```
public SearchShardTarget getShard()
```
    インタフェースからコピーされた説明: SearchHit
    
    The shard of the search hit.
    
    定義:
    
    getShard インタフェース内 SearchHit
  - shard
```
public void shard(SearchShardTarget target)
```
  - matchedQueries
```
public void matchedQueries(String[] matchedQueries)
```
  - matchedQueries
```
public String[] matchedQueries()
```
    インタフェースからコピーされた説明: SearchHit
    
    The set of query and filter names the query matched with. Mainly makes sense for compound filters and queries.
    
    定義:
    
    matchedQueries インタフェース内 SearchHit
  - getMatchedQueries
```
public String[] getMatchedQueries()
```
    インタフェースからコピーされた説明: SearchHit
    
    The set of query and filter names the query matched with. Mainly makes sense for compound filters and queries.
    
    定義:
    
    getMatchedQueries インタフェース内 SearchHit
  - getInnerHits
```
public Map<String,SearchHits> getInnerHits()
```
    定義:
    
    getInnerHits インタフェース内 SearchHit
    
    戻り値:
    
    Inner hits or null if there are none
  - setInnerHits
```
public void setInnerHits(Map<String,InternalSearchHits> innerHits)
```
  - toXContent
```
public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException
```
    定義:
    
    toXContent インタフェース内 ToXContent
    
    例外:
    
    IOException
  - readSearchHit
```
public static InternalSearchHit readSearchHit(StreamInput in,
                                              InternalSearchHits.StreamContext context)
                                       throws IOException
```
    例外:
    
    IOException
  - readFrom
```
public void readFrom(StreamInput in)
              throws IOException
```
    定義:
    
    readFrom インタフェース内 Streamable
    
    例外:
    
    IOException
  - readFrom
```
public void readFrom(StreamInput in,
                     InternalSearchHits.StreamContext context)
              throws IOException
```
    例外:
    
    IOException
  - writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
    定義:
    
    writeTo インタフェース内 Streamable
    
    例外:
    
    IOException
  - writeTo
```
public void writeTo(StreamOutput out,
                    InternalSearchHits.StreamContext context)
             throws IOException
```
    例外:
    
    IOException

クラス InternalSearchHit

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

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

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

フィールドのサマリー

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

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

メソッドのサマリー

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

インタフェースから継承されたメソッド java.lang.Iterable

コンストラクタの詳細

InternalSearchHit

InternalSearchHit

メソッドの詳細

docId

shardTarget

score

score

getScore

version

version

getVersion

index

getIndex

id

getId

type

getType

getNestedIdentity

sourceRef

sourceRef

getSourceRef

internalSourceRef

source

isSourceEmpty

getSource

sourceAsString

getSourceAsString

sourceAsMap

iterator

field

fields

fieldsOrNull

getFields

fields

internalHighlightFields

highlightFields

getHighlightFields

highlightFields

sortValues

sortValues

getSortValues

explanation

getExplanation

explanation

shard

getShard

shard

matchedQueries

matchedQueries

getMatchedQueries

getInnerHits

setInnerHits

toXContent

readSearchHit

readFrom

readFrom

writeTo

writeTo