Package org.elasticsearch.client.graph
Class Vertex
java.lang.Object
org.elasticsearch.client.graph.Vertex
- All Implemented Interfaces:
org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentFragment
A vertex in a graph response represents a single term (a field and value pair)
which appears in one or more documents found as part of the graph exploration.
A vertex term could be a bank account number, an email address, a hashtag or any
other term that appears in documents and is interesting to represent in a network.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An identifier (implements hashcode and equals) that represents a unique key for aVertex
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
-
Field Summary
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Vertex.VertexId
A convenience method for creating aVertex.VertexId
boolean
long
getBg()
If theGraphExploreRequest.useSignificance(boolean)
is true (the default) this statistic is available.long
getFg()
If theGraphExploreRequest.useSignificance(boolean)
is true (the default) this statistic is available.getField()
int
getId()
getTerm()
double
The weight of a vertex is an accumulation of all of theConnection
s that are linked to thisVertex
as part of a graph exploration.int
hashCode()
void
setFg
(long fg) void
setWeight
(double weight) toString()
org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Constructor Details
-
Vertex
-
-
Method Details
-
hashCode
public int hashCode() -
equals
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-
getId
- Returns:
- a
Vertex.VertexId
object that uniquely identifies this Vertex
-
createId
A convenience method for creating aVertex.VertexId
- Parameters:
field
- the fieldterm
- the term- Returns:
- a
Vertex.VertexId
that can be used for looking up vertices
-
toString
-
getField
-
getTerm
-
getWeight
public double getWeight()The weight of a vertex is an accumulation of all of theConnection
s that are linked to thisVertex
as part of a graph exploration. It is used internally to identify the most interesting vertices to be returned.- Returns:
- a measure of the
Vertex
's relative importance.
-
setWeight
public void setWeight(double weight) -
getBg
public long getBg()If theGraphExploreRequest.useSignificance(boolean)
is true (the default) this statistic is available.- Returns:
- the number of documents in the index that contain this term (see bg_count in the significant_terms aggregation)
-
getFg
public long getFg()If theGraphExploreRequest.useSignificance(boolean)
is true (the default) this statistic is available. Together withgetBg()
these numbers are used to derive the significance of a term.- Returns:
- the number of documents in the sample of best matching documents that contain this term (see fg_count in the significant_terms aggregation)
-
setFg
public void setFg(long fg) -
getHopDepth
public int getHopDepth()- Returns:
- the sequence number in the series of hops where this Vertex term was first encountered
-