com.sharethis.textrank

Class NGram

java.lang.Object

com.sharethis.textrank.NodeValue

com.sharethis.textrank.NGram

All Implemented Interfaces:

Comparable<NGram>

public class NGram
extends NodeValue
implements Comparable<NGram>

Implements a wrapper for tallying an n-gram in the text contains of selected keywords.

Author:

paco@sharethis.com

Field Summary

Fields

Modifier and Type	Field and Description
Set<Context>	contexts
int	length
Set<Node>	nodes Public members.

Fields inherited from class com.sharethis.textrank.NodeValue

text

Method Summary

Modifier and Type	Method and Description
static NGram	buildNGram(Graph ngrams, Sentence s, List<Integer> token_span, double max_rank) Factory method.
static int	calcStats(Graph subgraph) Determine a statistical distribution for the n-gram subgraph.
static Graph	collectNGrams(LanguageModel lang, List<Sentence> s_list, double rank_threshold) Report the n-grams marked in each sentence.
int	compareTo(NGram that) Compare method for sort ordering.
boolean	equals(Object obj)
int	getCount() Determine the count, i.e., how often this n-gram recurs within the text.
String	getDescription() Create a description text for this value.
int	hashCode()
String	renderContexts() Short-cut replacement for a toString() method.

Methods inherited from class com.sharethis.textrank.NodeValue

getCollocation

Methods inherited from class java.lang.Object

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

Field Detail

nodes

public Set<Node> nodes

Public members.

contexts

public Set<Context> contexts

length

public int length

Method Detail

getCount

public int getCount()

Determine the count, i.e., how often this n-gram recurs within the text.

getDescription

public String getDescription()

Create a description text for this value.

Overrides:

getDescription in class NodeValue

renderContexts

public String renderContexts()

Short-cut replacement for a toString() method.

compareTo

public int compareTo(NGram that)

Compare method for sort ordering.

Specified by:

compareTo in interface Comparable<NGram>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

buildNGram

public static NGram buildNGram(Graph ngrams,
                               Sentence s,
                               List<Integer> token_span,
                               double max_rank)

Factory method.

collectNGrams

public static Graph collectNGrams(LanguageModel lang,
                                  List<Sentence> s_list,
                                  double rank_threshold)

Report the n-grams marked in each sentence.

calcStats

public static int calcStats(Graph subgraph)

Determine a statistical distribution for the n-gram subgraph.