Package org.intermine.web.search

Class KeywordSearchResult

java.lang.Object

org.intermine.web.search.KeywordSearchResult

public class KeywordSearchResult
extends java.lang.Object

Container for a single result row from the keyword search

Author:

nils

Constructor Summary

Constructors

Constructor	Description
KeywordSearchResult(WebConfig webconfig, InterMineObject object, java.util.Map<java.lang.String,java.util.List<FieldDescriptor>> classKeys, ClassDescriptor classDescriptor, float score, java.util.Map<java.lang.String,TemplateQuery> templates, java.lang.String linkRedirect)	create the container object - automatically reads fields and saves the results in members

Method Summary

Modifier and Type	Method	Description
java.util.Vector<java.lang.String>	getAdditionalFields()	additional display field expressions
java.util.HashMap<java.lang.String,FieldConfig>	getFieldConfigs()	fieldConfigs
java.util.HashMap<java.lang.String,java.lang.Object>	getFieldValues()	values of all fields
int	getId()	intermine ID
java.util.Vector<java.lang.String>	getKeyFields()	key field expressions
java.lang.String	getLinkRedirect()	URL set in web.properties.
InterMineObject	getObject()	returns original intermine object
int	getPoints()	return points
float	getScore()	return score
java.util.Map<java.lang.String,TemplateQuery>	getTemplates()	templates associated with this class
java.lang.String	getType()	returns the name of the class for this object (category)

Methods inherited from class java.lang.Object

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

Constructor Detail

KeywordSearchResult

public KeywordSearchResult(WebConfig webconfig,
                           InterMineObject object,
                           java.util.Map<java.lang.String,java.util.List<FieldDescriptor>> classKeys,
                           ClassDescriptor classDescriptor,
                           float score,
                           java.util.Map<java.lang.String,TemplateQuery> templates,
                           java.lang.String linkRedirect)

create the container object - automatically reads fields and saves the results in members

Parameters:

webconfig - webconfig

object - the object this result should contain

classKeys - keys associated with this class

classDescriptor - descriptor for this class

score - score for this hit

templates - templatequeries for this class

linkRedirect - URL that search result will link to, if not report page

Method Detail

getObject

public InterMineObject getObject()

returns original intermine object

Returns:

object

getId

public int getId()

intermine ID

Returns:

x

getType

public java.lang.String getType()

returns the name of the class for this object (category)

Returns:

type

getScore

public float getScore()

return score

Returns:

...

getTemplates

public java.util.Map<java.lang.String,TemplateQuery> getTemplates()

templates associated with this class

Returns:

map of internal template name to template query

getPoints

public int getPoints()

return points

Returns:

1..10

getLinkRedirect

public java.lang.String getLinkRedirect()

URL set in web.properties.

Returns:

the URL the search result will link to. if NULL, link to report page

getFieldConfigs

public java.util.HashMap<java.lang.String,FieldConfig> getFieldConfigs()

fieldConfigs

Returns:

map from field expression to fieldConfigs

getKeyFields

public final java.util.Vector<java.lang.String> getKeyFields()

key field expressions

Returns:

keyFields

getAdditionalFields

public final java.util.Vector<java.lang.String> getAdditionalFields()

additional display field expressions

Returns:

additionalFields

getFieldValues

public java.util.HashMap<java.lang.String,java.lang.Object> getFieldValues()

values of all fields

Returns:

map from field expression to value