com.exalead.search.v30

Class LuaFacet

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.Facet

com.exalead.search.v30.VirtualFacet

com.exalead.search.v30.LuaFacet

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class LuaFacet
extends VirtualFacet
implements com.exalead.util.Checkable, java.io.Serializable

A virtual facet implemented using the Lua scripting language.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.search.v30.VirtualFacet

VirtualFacet.Transformer<T>, VirtualFacet.Visitor

Nested classes/interfaces inherited from class com.exalead.search.v30.Facet

Facet.FromDataModel, Facet.Implementation, Facet.RefinementPolicy, Facet.Type

Nested classes/interfaces inherited from class com.exalead.search.v30.FacetView

FacetView.SortFunction

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	luaCode

Fields inherited from class com.exalead.search.v30.VirtualFacet

virtualRoot

Fields inherited from class com.exalead.search.v30.Facet

additionalFacetView, aggregationFunction, dataModelClass, dataModelProperty, dataModelState, DEFAULT_IMPLEMENTATION, DEFAULT_IN_HITS, DEFAULT_IN_NAVIGATION, DEFAULT_MAX_SLICE_CATEGORIES, DEFAULT_REFINEMENT_POLICY, fromDataModel, id, implementation, index, inHits, inNavigation, maxSliceCategories, refinementPolicy, type

Fields inherited from class com.exalead.search.v30.FacetView

aggregateScores, DEFAULT_AGGREGATE_SCORES, DEFAULT_MAX_CATEGORIES, DEFAULT_MAX_CATEGORIES_PER_LEVEL, DEFAULT_MIN_DOCS_PER_CATEGORY, DEFAULT_REVERSE, DEFAULT_SORT_FUNCTION, explicitSortOrderValues, maxCategories, maxCategoriesPerLevel, minDocsPerCategory, reverse, sortAggregationFunction, sortFunction

Constructor Summary

Constructors

Constructor and Description
LuaFacet()
LuaFacet(LuaFacet o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(Facet.Transformer<T> transformer, T[] t)
void	accept(Facet.Visitor visitor)
<T> T	accept(FacetView.Transformer<T> transformer, T[] t)
void	accept(FacetView.Visitor visitor)
<T> T	accept(VirtualFacet.Transformer<T> transformer, T[] t)
void	accept(VirtualFacet.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this LuaFacet.
static LuaFacet	fromString(java.lang.String s) String representation of this LuaFacet.
java.lang.String	getLuaCode() The lua code for the facet.
LuaFacet	makeCopy() Creates and returns a deep copy of this LuaFacet.
static LuaFacet	readFrom(java.io.InputStream is) Read this LuaFacet from an XML fragment.
void	setLuaCode(java.lang.String luaCode) The lua code for the facet.
java.lang.String	toString() String representation of this LuaFacet.
LuaFacet	withAdditionalFacetView(AdditionalFacetView... __values)
LuaFacet	withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
LuaFacet	withAggregateScores(boolean aggregateScores) Deprecated.
LuaFacet	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
LuaFacet	withAggregationFunction(AggregationFunction... __values) A numerical computation to perform on hits matching each value of the facet.
LuaFacet	withAggregationFunction(java.util.Collection<AggregationFunction> __values)
LuaFacet	withDataModelClass(java.lang.String dataModelClass)
LuaFacet	withDataModelProperty(java.lang.String dataModelProperty)
LuaFacet	withDataModelState(java.lang.String dataModelState)
LuaFacet	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
LuaFacet	withFromDataModel(Facet fromDataModel)
LuaFacet	withId(java.lang.String id)
LuaFacet	withImplementation(java.lang.String implementation)
LuaFacet	withIndex(int index)
LuaFacet	withIndex(java.lang.Integer index)
LuaFacet	withInHits(boolean inHits)
LuaFacet	withInHits(java.lang.Boolean inHits)
LuaFacet	withInNavigation(boolean inNavigation)
LuaFacet	withInNavigation(java.lang.Boolean inNavigation)
LuaFacet	withLuaCode(java.lang.String luaCode)
LuaFacet	withMaxCategories(int maxCategories)
LuaFacet	withMaxCategories(java.lang.Integer maxCategories)
LuaFacet	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
LuaFacet	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
LuaFacet	withMaxSliceCategories(int maxSliceCategories)
LuaFacet	withMaxSliceCategories(java.lang.Integer maxSliceCategories)
LuaFacet	withMinDocsPerCategory(int minDocsPerCategory)
LuaFacet	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
LuaFacet	withRefinementPolicy(java.lang.String refinementPolicy)
LuaFacet	withReverse(boolean reverse)
LuaFacet	withReverse(java.lang.Boolean reverse)
LuaFacet	withSortAggregationFunction(java.lang.String sortAggregationFunction)
LuaFacet	withSortFunction(java.lang.String sortFunction)
LuaFacet	withType(java.lang.String type)
LuaFacet	withVirtualRoot(java.lang.String virtualRoot)
void	writeTo(java.io.OutputStream os) Write this LuaFacet as an XML fragment

Methods inherited from class com.exalead.search.v30.VirtualFacet

getVirtualRoot, setVirtualRoot

Methods inherited from class com.exalead.search.v30.Facet

getAdditionalFacetView, getAdditionalFacetViewAsMap, getAdditionalFacetViewById, getAggregationFunction, getAggregationFunctionAsMap, getAggregationFunctionById, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getId, getImplementation, getImplementationAsEnum, getIndex, getMaxSliceCategories, getRefinementPolicy, getRefinementPolicyAsEnum, getType, getTypeAsEnum, isA, isA, isA, isInHits, isInNavigation, isOneOf, isOneOf, isOneOf, removeAdditionalFacetViewById, removeAggregationFunctionById, setDataModelClass, setDataModelProperty, setDataModelState, setFromDataModel, setId, setImplementation, setImplementation, setIndex, setInHits, setInNavigation, setMaxSliceCategories, setRefinementPolicy, setRefinementPolicy, setType, setType

Methods inherited from class com.exalead.search.v30.FacetView

getExplicitSortOrderValues, getMaxCategories, getMaxCategoriesPerLevel, getMinDocsPerCategory, getSortAggregationFunction, getSortFunction, getSortFunctionAsEnum, isA, isAggregateScores, isOneOf, isReverse, setAggregateScores, setExplicitSortOrderValues, setMaxCategories, setMaxCategoriesPerLevel, setMinDocsPerCategory, setReverse, setSortAggregationFunction, setSortFunction, setSortFunction

Methods inherited from class java.lang.Object

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

Field Detail

luaCode

public java.lang.String luaCode

Constructor Detail

LuaFacet

public LuaFacet()

LuaFacet

public LuaFacet(LuaFacet o)

Copy constructor

Method Detail

withVirtualRoot

public LuaFacet withVirtualRoot(java.lang.String virtualRoot)

Overrides:

withVirtualRoot in class VirtualFacet

withId

public LuaFacet withId(java.lang.String id)

Overrides:

withId in class VirtualFacet

withType

public LuaFacet withType(java.lang.String type)

Overrides:

withType in class VirtualFacet

withIndex

public LuaFacet withIndex(int index)

Overrides:

withIndex in class VirtualFacet

withIndex

public LuaFacet withIndex(java.lang.Integer index)

Overrides:

withIndex in class VirtualFacet

withRefinementPolicy

public LuaFacet withRefinementPolicy(java.lang.String refinementPolicy)

Overrides:

withRefinementPolicy in class VirtualFacet

withImplementation

public LuaFacet withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class VirtualFacet

withDataModelState

public LuaFacet withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class VirtualFacet

withFromDataModel

public LuaFacet withFromDataModel(Facet fromDataModel)

Overrides:

withFromDataModel in class VirtualFacet

withDataModelClass

public LuaFacet withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class VirtualFacet

withDataModelProperty

public LuaFacet withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class VirtualFacet

withInNavigation

public LuaFacet withInNavigation(boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInNavigation

public LuaFacet withInNavigation(java.lang.Boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInHits

public LuaFacet withInHits(boolean inHits)

Overrides:

withInHits in class VirtualFacet

withInHits

public LuaFacet withInHits(java.lang.Boolean inHits)

Overrides:

withInHits in class VirtualFacet

withAggregationFunction

public LuaFacet withAggregationFunction(AggregationFunction... __values)

A numerical computation to perform on hits matching each value of the facet.

Overrides:

withAggregationFunction in class VirtualFacet

withAggregationFunction

public LuaFacet withAggregationFunction(java.util.Collection<AggregationFunction> __values)

Overrides:

withAggregationFunction in class VirtualFacet

withAdditionalFacetView

public LuaFacet withAdditionalFacetView(AdditionalFacetView... __values)

Overrides:

withAdditionalFacetView in class VirtualFacet

withAdditionalFacetView

public LuaFacet withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)

Overrides:

withAdditionalFacetView in class VirtualFacet

withMaxSliceCategories

public LuaFacet withMaxSliceCategories(int maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMaxSliceCategories

public LuaFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMinDocsPerCategory

public LuaFacet withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMinDocsPerCategory

public LuaFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMaxCategories

public LuaFacet withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategories

public LuaFacet withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategoriesPerLevel

public LuaFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withMaxCategoriesPerLevel

public LuaFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withSortFunction

public LuaFacet withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class VirtualFacet

withSortAggregationFunction

public LuaFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class VirtualFacet

withExplicitSortOrderValues

public LuaFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class VirtualFacet

withReverse

public LuaFacet withReverse(boolean reverse)

Overrides:

withReverse in class VirtualFacet

withReverse

public LuaFacet withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class VirtualFacet

withAggregateScores

@Deprecated
public LuaFacet withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class VirtualFacet

withAggregateScores

@Deprecated
public LuaFacet withAggregateScores(java.lang.Boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class VirtualFacet

setLuaCode

public void setLuaCode(java.lang.String luaCode)

The lua code for the facet.

getLuaCode

public java.lang.String getLuaCode()

The lua code for the facet.

withLuaCode

public LuaFacet withLuaCode(java.lang.String luaCode)

makeCopy

public LuaFacet makeCopy()

Creates and returns a deep copy of this LuaFacet.

Overrides:

makeCopy in class VirtualFacet

readFrom

public static LuaFacet readFrom(java.io.InputStream is)
                         throws javax.xml.bind.JAXBException

Read this LuaFacet from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this LuaFacet as an XML fragment

Overrides:

writeTo in class VirtualFacet

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static LuaFacet fromString(java.lang.String s)
                           throws javax.xml.bind.JAXBException,
                                  java.io.UnsupportedEncodingException

String representation of this LuaFacet.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this LuaFacet.

Overrides:

toString in class VirtualFacet

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this LuaFacet.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class VirtualFacet

Throws:

com.exalead.util.TypedException

accept

public void accept(VirtualFacet.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class VirtualFacet

Throws:

com.exalead.util.TypedException

accept

public void accept(Facet.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class Facet

Throws:

com.exalead.util.TypedException

accept

public void accept(FacetView.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class FacetView

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(VirtualFacet.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class VirtualFacet

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(Facet.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class Facet

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(FacetView.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class FacetView

Throws:

com.exalead.util.TypedException