uk.ac.open.kmi.watson.services
Class SearchConf

java.lang.Object
  extended by uk.ac.open.kmi.watson.services.SearchConf
All Implemented Interfaces:
java.io.Serializable

public class SearchConf
extends java.lang.Object
implements java.io.Serializable

This class is used to create configuration objects used to parametrize search functions.

Author:
mda99
See Also:
Serialized Form

Field Summary
static int CLASS
          entity modifier for classes.
static int COMMENT
          scope modifier for comments.
static int ENT_ANYLITERAL_INFO
          for entInfo: request the information about the literal relations of the entity
static int ENT_ANYRELATIONFROM_INFO
          for entInfo: request the information about the relations from the entity
static int ENT_ANYRELATIONTO_INFO
          for entInfo: request the information about the relations to the entity
static int ENT_COMMENT_INFO
          for entInfo: request the information about the comment of the entity
static int ENT_LABEL_INFO
          for entInfo: request the information about the label of the entity
static int ENT_TYPE_INFO
          for entInfo: request the information about the type of the entity
static int EXACT_MATCH
          Matcher: exact match of a normalized form
static int INDIVIDUAL
          entity modifier for individuals.
static int LABEL
          scope modifier for labels.
static int LITERAL
          scope modifier for other related literals.
static int LOCAL_NAME
          scope modifier for local names.
static int NS
          scope modifier for namsespaces.
static int PROPERTY
          entity modifier for properties.
static int SC_COMMENTS_INFO
          for scInfo: request the information about the comments of the ontology
static int SC_DLEXPR_INFO
          for scInfo: request the information about the size of the semantic document
static int SC_DOMAIN_INFO
          for scInfo: request the information about the domain
static int SC_ENTITIES_INFO
          for scInfo: request the information about the entities...
static int SC_IMPORTEDBY_INFO
          for scInfo: request the information about the ontologies importing the semantic document
static int SC_IMPORTS_INFO
          for scInfo: request the information about the imported ontologies in the semantic document
static int SC_LABELS_INFO
          for scInfo: request the information about the labels of the ontology
static int SC_LANGUAGES_INFO
          for scInfo: request the information about the languages used in the semantic document
static int SC_LOCATION_INFO
          for scInfo: request the information about the Dl Expressiveness used in the semantic document
static int SC_NBCLASSES_INFO
          for scInfo: request the information about the number of classes in the semantic document
static int SC_NBINDIS_INFO
          for scInfo: request the information about the number of individuals in the semantic document
static int SC_NBPROPS_INFO
          for scInfo: request the information about the number of properties in the semantic document
static int SC_NBSTATS_INFO
          for scInfo: request the information about the number of statements in the semantic document
static int SC_SIZE_INFO
          for scInfo: request the information about the languages used in the semantic document
static int TOKEN_MATCH
          Matcher: match a token
 
Constructor Summary
SearchConf()
           
 
Method Summary
 int getEntities()
          returns the matching entities parameter
 int getEntitiesInfo()
          get the element that will be returned in the entity result
 java.lang.String[][] getFilters()
          get the filters applied
 int getInc()
          get the number of result that will be obtained
 int getMatch()
          get the matching function
 int[] getRankingWeights()
          undocumented
 int getSCInfo()
          get the elements to be included in the semantic content result
 int getScope()
          get the scope parameter
 int[] getSorts()
          undocumented
 int getStart()
          get the indice of the first element to be returned
 void setEntities(int entities)
          set the entities to be matched
 void setEntitiesInfo(int entitiesInfo)
          set the element that will be returned in the entity result
 void setFilters(java.lang.String[][] filters)
          set the filters to apply
 void setInc(int inc)
          set the number of results that should be returned
 void setMatch(int match)
          set the matching function (EXACT_MATCH or TOKEN_MATCH)
 void setRankingWeights(int[] rankingWeights)
          undocumented
 void setSCInfo(int info)
          set the elements to be included in the semantic content result
 void setScope(int scope)
          set the scope parameter
 void setSorts(int[] sorts)
          undocumented
 void setStart(int start)
          set the indice of the first element to be returned
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS

public static final int CLASS
entity modifier for classes.

See Also:
Constant Field Values

PROPERTY

public static final int PROPERTY
entity modifier for properties.

See Also:
Constant Field Values

INDIVIDUAL

public static final int INDIVIDUAL
entity modifier for individuals.

See Also:
Constant Field Values

NS

public static final int NS
scope modifier for namsespaces.

See Also:
Constant Field Values

LOCAL_NAME

public static final int LOCAL_NAME
scope modifier for local names.

See Also:
Constant Field Values

LABEL

public static final int LABEL
scope modifier for labels.

See Also:
Constant Field Values

COMMENT

public static final int COMMENT
scope modifier for comments.

See Also:
Constant Field Values

LITERAL

public static final int LITERAL
scope modifier for other related literals.

See Also:
Constant Field Values

TOKEN_MATCH

public static final int TOKEN_MATCH
Matcher: match a token

See Also:
Constant Field Values

EXACT_MATCH

public static final int EXACT_MATCH
Matcher: exact match of a normalized form

See Also:
Constant Field Values

SC_LANGUAGES_INFO

public static final int SC_LANGUAGES_INFO
for scInfo: request the information about the languages used in the semantic document

See Also:
Constant Field Values

SC_SIZE_INFO

public static final int SC_SIZE_INFO
for scInfo: request the information about the languages used in the semantic document

See Also:
Constant Field Values

SC_DLEXPR_INFO

public static final int SC_DLEXPR_INFO
for scInfo: request the information about the size of the semantic document

See Also:
Constant Field Values

SC_LOCATION_INFO

public static final int SC_LOCATION_INFO
for scInfo: request the information about the Dl Expressiveness used in the semantic document

See Also:
Constant Field Values

SC_NBCLASSES_INFO

public static final int SC_NBCLASSES_INFO
for scInfo: request the information about the number of classes in the semantic document

See Also:
Constant Field Values

SC_NBPROPS_INFO

public static final int SC_NBPROPS_INFO
for scInfo: request the information about the number of properties in the semantic document

See Also:
Constant Field Values

SC_NBINDIS_INFO

public static final int SC_NBINDIS_INFO
for scInfo: request the information about the number of individuals in the semantic document

See Also:
Constant Field Values

SC_NBSTATS_INFO

public static final int SC_NBSTATS_INFO
for scInfo: request the information about the number of statements in the semantic document

See Also:
Constant Field Values

SC_IMPORTS_INFO

public static final int SC_IMPORTS_INFO
for scInfo: request the information about the imported ontologies in the semantic document

See Also:
Constant Field Values

SC_IMPORTEDBY_INFO

public static final int SC_IMPORTEDBY_INFO
for scInfo: request the information about the ontologies importing the semantic document

See Also:
Constant Field Values

SC_LABELS_INFO

public static final int SC_LABELS_INFO
for scInfo: request the information about the labels of the ontology

See Also:
Constant Field Values

SC_COMMENTS_INFO

public static final int SC_COMMENTS_INFO
for scInfo: request the information about the comments of the ontology

See Also:
Constant Field Values

SC_ENTITIES_INFO

public static final int SC_ENTITIES_INFO
for scInfo: request the information about the entities...

See Also:
Constant Field Values

SC_DOMAIN_INFO

public static final int SC_DOMAIN_INFO
for scInfo: request the information about the domain

See Also:
Constant Field Values

ENT_TYPE_INFO

public static final int ENT_TYPE_INFO
for entInfo: request the information about the type of the entity

See Also:
Constant Field Values

ENT_LABEL_INFO

public static final int ENT_LABEL_INFO
for entInfo: request the information about the label of the entity

See Also:
Constant Field Values

ENT_COMMENT_INFO

public static final int ENT_COMMENT_INFO
for entInfo: request the information about the comment of the entity

See Also:
Constant Field Values

ENT_ANYRELATIONFROM_INFO

public static final int ENT_ANYRELATIONFROM_INFO
for entInfo: request the information about the relations from the entity

See Also:
Constant Field Values

ENT_ANYRELATIONTO_INFO

public static final int ENT_ANYRELATIONTO_INFO
for entInfo: request the information about the relations to the entity

See Also:
Constant Field Values

ENT_ANYLITERAL_INFO

public static final int ENT_ANYLITERAL_INFO
for entInfo: request the information about the literal relations of the entity

See Also:
Constant Field Values
Constructor Detail

SearchConf

public SearchConf()
Method Detail

getEntities

public int getEntities()
returns the matching entities parameter


setEntities

public void setEntities(int entities)
set the entities to be matched

Parameters:
entities - a number indicating which entities should be march (default CLASS+PROPERTY+INDIVIDUAL)

getEntitiesInfo

public int getEntitiesInfo()
get the element that will be returned in the entity result


setEntitiesInfo

public void setEntitiesInfo(int entitiesInfo)
set the element that will be returned in the entity result


getFilters

public java.lang.String[][] getFilters()
get the filters applied


setFilters

public void setFilters(java.lang.String[][] filters)
set the filters to apply

Parameters:
filters - [0] filter name (e.g. language, user) [1] filter value (e.g. OWL)

getMatch

public int getMatch()
get the matching function


setMatch

public void setMatch(int match)
set the matching function (EXACT_MATCH or TOKEN_MATCH)


getRankingWeights

public int[] getRankingWeights()
undocumented


setRankingWeights

public void setRankingWeights(int[] rankingWeights)
undocumented


getSCInfo

public int getSCInfo()
get the elements to be included in the semantic content result


setSCInfo

public void setSCInfo(int info)
set the elements to be included in the semantic content result


getScope

public int getScope()
get the scope parameter


setScope

public void setScope(int scope)
set the scope parameter

Parameters:
scope - where the keyword should be matched (default LOCAL_NAME+LABEL+COMMENT+ANY_LITERAL)

getSorts

public int[] getSorts()
undocumented


setSorts

public void setSorts(int[] sorts)
undocumented


getInc

public int getInc()
get the number of result that will be obtained


setInc

public void setInc(int inc)
set the number of results that should be returned

Parameters:
inc - -1 if un restricted

getStart

public int getStart()
get the indice of the first element to be returned


setStart

public void setStart(int start)
set the indice of the first element to be returned

Parameters:
start - 0 for the first