org.kuali.rice.krms.api.repository

Class NaturalLanguage.Builder

java.lang.Object

org.kuali.rice.krms.api.repository.NaturalLanguage.Builder

All Implemented Interfaces:

Serializable, ModelBuilder, NaturalLanguageContract

Enclosing class:

NaturalLanguage

public static class NaturalLanguage.Builder
extends Object
implements NaturalLanguageContract, ModelBuilder, Serializable

This builder is used to construct instances of KRMS Repository Agenda. It enforces the constraints of the NaturalLanguageContract.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
NaturalLanguage	build() Builds an instance of a Natural Language Tree based on the current state of the builder.
static NaturalLanguage.Builder	create() Creates a builder by populating it with data from the given NaturalLanguageContract.
static NaturalLanguage.Builder	create(NaturalLanguageContract contract) Creates a builder by populating it with data from the given NaturalLanguageContract.
String	getKrmsObjectId() Returns the krms object id associated with the natural language.
String	getNaturalLanguage() Returns the natural language representation for this node in the tree
void	setKrmsObjectId(String krmsObjectId)
void	setNaturalLanguage(String naturalLanguage)

Methods inherited from class java.lang.Object

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

Method Detail

getKrmsObjectId

public String getKrmsObjectId()

Description copied from interface: NaturalLanguageContract

Returns the krms object id associated with the natural language.

Specified by:

getKrmsObjectId in interface NaturalLanguageContract

Returns:

the krms object id

setKrmsObjectId

public void setKrmsObjectId(String krmsObjectId)

getNaturalLanguage

public String getNaturalLanguage()

Description copied from interface: NaturalLanguageContract

Returns the natural language representation for this node in the tree

Specified by:

getNaturalLanguage in interface NaturalLanguageContract

Returns:

the natural language representation for this node in the tree

setNaturalLanguage

public void setNaturalLanguage(String naturalLanguage)

create

public static NaturalLanguage.Builder create()

Creates a builder by populating it with data from the given NaturalLanguageContract.

Returns:

an instance of the builder populated with data from the contract

Throws:

IllegalArgumentException - if the contract is null

create

public static NaturalLanguage.Builder create(NaturalLanguageContract contract)

Creates a builder by populating it with data from the given NaturalLanguageContract.

Parameters:

contract - the contract from which to populate this builder

Returns:

an instance of the builder populated with data from the contract

Throws:

IllegalArgumentException - if the contract is null

build

public NaturalLanguage build()

Builds an instance of a Natural Language Tree based on the current state of the builder.

Specified by:

build in interface ModelBuilder

Returns:

the fully-constructed Agenda