org.wso2.carbon.analytics.dataservice.commons

Class AnalyticsDrillDownRequest

java.lang.Object

org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest

All Implemented Interfaces:

Serializable

public class AnalyticsDrillDownRequest
extends Object
implements Serializable

This class contains the details about Drill down search. Use this class when you need to query faceted/categorized information

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AnalyticsDrillDownRequest()
AnalyticsDrillDownRequest(String tableName, Map<String,List<String>> categoryPaths, String rangeField, List<AnalyticsDrillDownRange> ranges, String query, String scoreFunction, int recordCount, List<SortByField> sortByFields, int recordStart)

Method Summary

Methods

Modifier and Type	Method and Description
void	addCategoryPath(String field, List<String> categoryPath) Adds a facets to existing list of facets.
Map<String,List<String>>	getCategoryPaths() returns the list of Facets being queried.
String	getQuery() Returns the query expression.
String	getRangeField()
List<AnalyticsDrillDownRange>	getRanges()
int	getRecordCount() Returns the number of maximum records per a child facet in each facet field in drilldown result.
int	getRecordStartIndex()
String	getScoreFunction() Returns the Scoring function.
List<SortByField>	getSortByFields()
String	getTableName()
void	setCategoryPaths(Map<String,List<String>> categoryPaths) Sets the facets.
void	setQuery(String query) Sets the query expression in lucene or regex.
void	setRangeField(String rangeField)
void	setRanges(List<AnalyticsDrillDownRange> ranges)
void	setRecordCount(int recordCount) Sets the maximum number of records that can be there in a child facet in a facet field of result.
void	setRecordStartIndex(int recordStart) Set the starting index of the records under each cateogry
void	setScoreFunction(String score) Sets the score function.
void	setSortByFields(List<SortByField> sortByFields)
void	setTableName(String tableName) Sets the table Name.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyticsDrillDownRequest

public AnalyticsDrillDownRequest()

AnalyticsDrillDownRequest

public AnalyticsDrillDownRequest(String tableName,
                         Map<String,List<String>> categoryPaths,
                         String rangeField,
                         List<AnalyticsDrillDownRange> ranges,
                         String query,
                         String scoreFunction,
                         int recordCount,
                         List<SortByField> sortByFields,
                         int recordStart)

Method Detail

getTableName

public String getTableName()

setTableName

public void setTableName(String tableName)

Sets the table Name.

Parameters:

tableName - name of the table

getCategoryPaths

public Map<String,List<String>> getCategoryPaths()

returns the list of Facets being queried.

Returns:

list of facets

setCategoryPaths

public void setCategoryPaths(Map<String,List<String>> categoryPaths)

Sets the facets.

Parameters:

categoryPaths - list of facets

addCategoryPath

public void addCategoryPath(String field,
                   List<String> categoryPath)

Adds a facets to existing list of facets.

Parameters:

categoryPath - the facet object being inserted

getScoreFunction

public String getScoreFunction()

Returns the Scoring function.

Returns:

The score function

setScoreFunction

public void setScoreFunction(String score)

Sets the score function.

Parameters:

score - the score function

getQuery

public String getQuery()

Returns the query expression.

Returns:

the expression in regex or lucene

setQuery

public void setQuery(String query)

Sets the query expression in lucene or regex.

Parameters:

query -

getRecordCount

public int getRecordCount()

Returns the number of maximum records per a child facet in each facet field in drilldown result.

Returns:

the number of records in a child facet in max. Default value is 10, if not set.

setRecordCount

public void setRecordCount(int recordCount)

Sets the maximum number of records that can be there in a child facet in a facet field of result.

Parameters:

recordCount - The maximum number of records in achild facet.Default value is 0, if not set

getRecordStartIndex

public int getRecordStartIndex()

setRecordStartIndex

public void setRecordStartIndex(int recordStart)

Set the starting index of the records under each cateogry

Parameters:

recordStart - 0 based index

getRanges

public List<AnalyticsDrillDownRange> getRanges()

setRanges

public void setRanges(List<AnalyticsDrillDownRange> ranges)

getRangeField

public String getRangeField()

setRangeField

public void setRangeField(String rangeField)

getSortByFields

public List<SortByField> getSortByFields()

setSortByFields

public void setSortByFields(List<SortByField> sortByFields)