Package org.intermine.api.searchengine

Class KeywordSearchFacetData

java.lang.Object

org.intermine.api.searchengine.KeywordSearchFacetData

public class KeywordSearchFacetData
extends java.lang.Object

container class for a facet field and its settings

Author:

nils

Constructor Summary

Constructors

Constructor	Description
KeywordSearchFacetData(java.lang.String[] fields, java.lang.String name, KeywordSearchFacetType type)	constructor
KeywordSearchFacetData(java.lang.String field, java.lang.String name, KeywordSearchFacetType type)	convenience constructor for single field

Method Summary

Modifier and Type	Method	Description
java.lang.String	getField()	get single/first field or null
java.lang.String[]	getFields()	array of field names, only used for path right now
java.lang.String	getName()	name of the facet (displayed on page)
KeywordSearchFacetType	getType()	type of facet

Methods inherited from class java.lang.Object

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

Constructor Detail

KeywordSearchFacetData

public KeywordSearchFacetData(java.lang.String field,
                              java.lang.String name,
                              KeywordSearchFacetType type)

convenience constructor for single field

Parameters:

field - field to use as a value

name - name that is displayed to the user

type - type of the facet (single, multi, path, ...)

KeywordSearchFacetData

public KeywordSearchFacetData(java.lang.String[] fields,
                              java.lang.String name,
                              KeywordSearchFacetType type)

constructor

Parameters:

fields - fields to use as values (usually just one for single/multi facet, several for path)

name - name that is displayed to the user

type - type of the facet (single, multi, path, ...)

Method Detail

getField

public java.lang.String getField()

get single/first field or null

Returns:

field or null

getFields

public java.lang.String[] getFields()

array of field names, only used for path right now

Returns:

fields

getName

public java.lang.String getName()

name of the facet (displayed on page)

Returns:

name

getType

public KeywordSearchFacetType getType()

type of facet

Returns:

type