org.opencode4workspace.bo

Class Focus

java.lang.Object

org.opencode4workspace.bo.Focus

All Implemented Interfaces:

Serializable

public class Focus
extends Object
implements Serializable

Since:

0.8.0 Focus class, for parsing the response to a request to "/v1/focus" endpoint to analyse text against standard lenses

Author:

Paul Withers

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Focus.Lens

Constructor Summary

Constructors

Constructor and Description
Focus()

Method Summary

Modifier and Type	Method and Description
String	getApplicationId()
double	getConfidence()
int	getEnd()
int	getFocusVersion()
Focus.Lens	getLens()
String	getLensId()
String	getPhrase()
int	getStart()
boolean	isHidden()
void	setApplicationId(String applicationId)
void	setConfidence(double confidence)
void	setEnd(int end)
void	setFocusVersion(int focusVersion)
void	setHidden(boolean hidden)
void	setLens(Focus.Lens lens)
void	setLensId(String lensId)
void	setPhrase(String phrase)
void	setStart(int start)

Methods inherited from class java.lang.Object

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

Constructor Detail

Focus

public Focus()

Method Detail

getLens

public Focus.Lens getLens()

Returns:

Lens this focus was generated by

Since:

0.8.0

setLens

public void setLens(Focus.Lens lens)

Parameters:

lens - Lens this focus was generated by

Since:

0.8.0

getStart

public int getStart()

Returns:

int start index within the text passed for the phrase identified

Since:

0.8.0

setStart

public void setStart(int start)

Parameters:

start - int start index within the text passed for the phrase identified

Since:

0.8.0

getEnd

public int getEnd()

Returns:

int end index within the text passed for the phrase identified

Since:

0.8.0

setEnd

public void setEnd(int end)

Parameters:

end - int end index within the text passed for the phrase identified

Since:

0.8.0

getPhrase

public String getPhrase()

Returns:

String phrase extracted from the text passed by the lens

Since:

0.8.0

setPhrase

public void setPhrase(String phrase)

Parameters:

phrase - String phrase extracted from the text passed by the lens

Since:

0.8.0

getConfidence

public double getConfidence()

Returns:

double confidence percentage Watson Workspace had in identifying the lens, between 0 and 1

Since:

0.8.0

setConfidence

public void setConfidence(double confidence)

Parameters:

confidence - double confidence percentage Watson Workspace had in identifying the lens, between 0 and 1

Since:

0.8.0

getApplicationId

public String getApplicationId()

Returns:

String id of the application with which the lens is associated

Since:

0.8.0

setApplicationId

public void setApplicationId(String applicationId)

Parameters:

applicationId - String id of the application with which the lens is associated

Since:

0.8.0

getLensId

public String getLensId()

Returns:

String auto-generated id of the Watson Conversation instance

Since:

0.8.0

setLensId

public void setLensId(String lensId)

Parameters:

lensId - String auto-generated id of the Watson Conversation instance

Since:

0.8.0

getFocusVersion

public int getFocusVersion()

Returns:

int version of the Focus object

Since:

0.8.0

setFocusVersion

public void setFocusVersion(int focusVersion)

Parameters:

focusVersion - int version of the Focus object

Since:

0.8.0

isHidden

public boolean isHidden()

Returns:

boolean whether or not the lens is hidden, seems to be false always in API response

Since:

0.8.0

setHidden

public void setHidden(boolean hidden)

Parameters:

hidden - boolean whether or not the lens is hidden, seems to be false always in API response

Since:

0.8.0