Package com.basistech.rosette.dm

Class Keyphrase.Builder

java.lang.Object

com.basistech.rosette.dm.BaseAttribute.Builder<Keyphrase,Keyphrase.Builder>

com.basistech.rosette.dm.Keyphrase.Builder

Enclosing class:

Keyphrase

public static class Keyphrase.Builder
extends BaseAttribute.Builder<Keyphrase,Keyphrase.Builder>

A builder for keyphrases

Constructor Summary

Constructors

Constructor	Description
Builder(Keyphrase toCopy)	Constructs a builder out of an existing Keyphrase
Builder(String phrase, List<Extent> extents)	Constructs a builder from the required properties

Method Summary

Modifier and Type	Method	Description
Keyphrase	build()	Returns an immutable Keyphrase out of the builder contents
Keyphrase.Builder	extents(List<Extent> extents)	Specify the list of offsets of each mention of the keyphrase
protected Keyphrase.Builder	getThis()
Keyphrase.Builder	phrase(String phrase)	Specify the name of the keyphrase
Keyphrase.Builder	salience(Double salience)	Specify the salience value for the keyphrase

Methods inherited from class com.basistech.rosette.dm.BaseAttribute.Builder

addAllToList, addAllToSet, buildExtendedProperties, extendedProperties, extendedProperty, nullOrList

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(String phrase,
 List<Extent> extents)

Constructs a builder from the required properties

Parameters:

phrase - the name of the keyphrase

extents - the list of extents marking offsets for each mention of the keyphrase in the text

Builder

public Builder(Keyphrase toCopy)

Constructs a builder out of an existing Keyphrase

Parameters:

toCopy - the keyphrase to copy

Method Details

phrase

public Keyphrase.Builder phrase(String phrase)

Specify the name of the keyphrase

Parameters:

phrase - the name of the keyphrase

Returns:

this

salience

public Keyphrase.Builder salience(Double salience)

Specify the salience value for the keyphrase

Parameters:

salience - the salience value

Returns:

this

extents

public Keyphrase.Builder extents(List<Extent> extents)

Specify the list of offsets of each mention of the keyphrase

Parameters:

extents - the list of extents

Returns:

this

build

public Keyphrase build()

Returns an immutable Keyphrase out of the builder contents

Returns:

the new Keyphrase

getThis

protected Keyphrase.Builder getThis()

Specified by:

getThis in class BaseAttribute.Builder<Keyphrase,Keyphrase.Builder>