SMILA (incubation) API documentation

org.eclipse.smila.search.api.helper
Class Terms

java.lang.Object
  extended by org.eclipse.smila.search.api.helper.AnnotationListAccessor
      extended by org.eclipse.smila.search.api.helper.Terms

public class Terms
extends AnnotationListAccessor

wrapper for annotations describing term lists (e.g. textminer token lists).

Author:
jschumacher

Constructor Summary
Terms(java.lang.String attributeName, java.util.Collection<Annotation> annotations)
          create instance from data.
Terms(java.lang.String attributeName, java.util.List<Annotation> annotations)
          create instance from data.
 
Method Summary
 java.lang.String getConcept(int index)
          get concept property of n'th term.
 java.lang.Integer getEndCharPos(int index)
          get end character position property of n'th term.
 java.lang.Integer getEndWordPos(int index)
          get end word position property of n'th term.
 java.lang.String getMethod(int index)
          get method (of recognition, analysis, extraction) property of n'th term.
 java.lang.String getPartOfSpeech(int index)
          get part-of-speech property of n'th term.
 java.lang.Double getQuality(int index)
          get quality property of n'th term.
 java.lang.Integer getStartCharPos(int index)
          get start character position property of n'th term.
 java.lang.Integer getStartWordPos(int index)
          get start word position property of n'th term.
 java.lang.String getTargetAttributeName(int index)
          get target attribute property of n'th term.
 java.lang.String getToken(int index)
          get token property of n'th term.
 
Methods inherited from class org.eclipse.smila.search.api.helper.AnnotationListAccessor
getAnnotation, getAnnotations, getAttributeName, getFloatProperty, getIntProperty, getProperty, getSource, length
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Terms

public Terms(java.lang.String attributeName,
             java.util.List<Annotation> annotations)
create instance from data.

Parameters:
attributeName - annotated attribute
annotations - terms annotations.

Terms

public Terms(java.lang.String attributeName,
             java.util.Collection<Annotation> annotations)
create instance from data.

Parameters:
attributeName - annotated attribute
annotations - terms annotations.
Method Detail

getConcept

public java.lang.String getConcept(int index)
get concept property of n'th term.

Parameters:
index - position in term list.
Returns:
concept of term, or null for invalid indexes

getToken

public java.lang.String getToken(int index)
get token property of n'th term.

Parameters:
index - position in term list.
Returns:
token of term, or null for invalid indexes

getTargetAttributeName

public java.lang.String getTargetAttributeName(int index)
get target attribute property of n'th term.

Parameters:
index - position in term list.
Returns:
target attribute of term, or null for invalid indexes

getStartCharPos

public java.lang.Integer getStartCharPos(int index)
get start character position property of n'th term.

Parameters:
index - position in term list.
Returns:
start character position of term, or null for invalid indexes

getEndCharPos

public java.lang.Integer getEndCharPos(int index)
get end character position property of n'th term.

Parameters:
index - position in term list.
Returns:
end character position of term, or null for invalid indexes

getStartWordPos

public java.lang.Integer getStartWordPos(int index)
get start word position property of n'th term.

Parameters:
index - position in term list.
Returns:
start word position of term, or null for invalid indexes

getEndWordPos

public java.lang.Integer getEndWordPos(int index)
get end word position property of n'th term.

Parameters:
index - position in term list.
Returns:
end word position of term, or null for invalid indexes

getPartOfSpeech

public java.lang.String getPartOfSpeech(int index)
get part-of-speech property of n'th term.

Parameters:
index - position in term list.
Returns:
part-of-speech descriptor of term, or null for invalid indexes

getMethod

public java.lang.String getMethod(int index)
get method (of recognition, analysis, extraction) property of n'th term.

Parameters:
index - position in term list.
Returns:
method of term, or null for invalid indexes

getQuality

public java.lang.Double getQuality(int index)
get quality property of n'th term.

Parameters:
index - position in term list.
Returns:
quality of term, or null for invalid indexes

SMILA (incubation) API documentation