com.exalead.search.v30

Class AdditionalFacetView

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.AdditionalFacetView

All Implemented Interfaces:

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

Direct Known Subclasses:

AdditionalCategoryFacetView, AdditionalDateFacetView

public class AdditionalFacetView
extends FacetView
implements com.exalead.util.Checkable, java.io.Serializable

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AdditionalFacetView.Transformer<T>
static interface	AdditionalFacetView.Visitor

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	id

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
AdditionalFacetView()
AdditionalFacetView(AdditionalFacetView o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(AdditionalFacetView.Transformer<T> transformer, T[] t)
void	accept(AdditionalFacetView.Visitor visitor)
<T> T	accept(FacetView.Transformer<T> transformer, T[] t)
void	accept(FacetView.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this AdditionalFacetView.
static AdditionalFacetView	fromString(java.lang.String s) String representation of this AdditionalFacetView.
java.lang.String	getId() Unique sub-identifier of this view.
AdditionalFacetView	makeCopy() Creates and returns a deep copy of this AdditionalFacetView.
static AdditionalFacetView	readFrom(java.io.InputStream is) Read this AdditionalFacetView from an XML fragment.
void	setId(java.lang.String id) Unique sub-identifier of this view.
java.lang.String	toString() String representation of this AdditionalFacetView.
AdditionalFacetView	withAggregateScores(boolean aggregateScores) Deprecated.
AdditionalFacetView	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
AdditionalFacetView	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
AdditionalFacetView	withId(java.lang.String id)
AdditionalFacetView	withMaxCategories(int maxCategories)
AdditionalFacetView	withMaxCategories(java.lang.Integer maxCategories)
AdditionalFacetView	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
AdditionalFacetView	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
AdditionalFacetView	withMinDocsPerCategory(int minDocsPerCategory)
AdditionalFacetView	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
AdditionalFacetView	withReverse(boolean reverse)
AdditionalFacetView	withReverse(java.lang.Boolean reverse)
AdditionalFacetView	withSortAggregationFunction(java.lang.String sortAggregationFunction)
AdditionalFacetView	withSortFunction(java.lang.String sortFunction)
void	writeTo(java.io.OutputStream os) Write this AdditionalFacetView as an XML fragment

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

id

public java.lang.String id

Constructor Detail

AdditionalFacetView

public AdditionalFacetView()

AdditionalFacetView

public AdditionalFacetView(AdditionalFacetView o)

Copy constructor

Method Detail

withMinDocsPerCategory

public AdditionalFacetView withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class FacetView

withMinDocsPerCategory

public AdditionalFacetView withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class FacetView

withMaxCategories

public AdditionalFacetView withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class FacetView

withMaxCategories

public AdditionalFacetView withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class FacetView

withMaxCategoriesPerLevel

public AdditionalFacetView withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class FacetView

withMaxCategoriesPerLevel

public AdditionalFacetView withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class FacetView

withSortFunction

public AdditionalFacetView withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class FacetView

withSortAggregationFunction

public AdditionalFacetView withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class FacetView

withExplicitSortOrderValues

public AdditionalFacetView withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class FacetView

withReverse

public AdditionalFacetView withReverse(boolean reverse)

Overrides:

withReverse in class FacetView

withReverse

public AdditionalFacetView withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class FacetView

withAggregateScores

@Deprecated
public AdditionalFacetView withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class FacetView

withAggregateScores

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

Deprecated.

Overrides:

withAggregateScores in class FacetView

setId

public void setId(java.lang.String id)

Unique sub-identifier of this view. Will be concatenated to the facet's id.
Used in Mashup-Builder and client applications to identify the facet.

getId

public java.lang.String getId()

Unique sub-identifier of this view. Will be concatenated to the facet's id.
Used in Mashup-Builder and client applications to identify the facet.

withId

public AdditionalFacetView withId(java.lang.String id)

makeCopy

public AdditionalFacetView makeCopy()

Creates and returns a deep copy of this AdditionalFacetView.

Overrides:

makeCopy in class FacetView

readFrom

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

Read this AdditionalFacetView 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 AdditionalFacetView as an XML fragment

Overrides:

writeTo in class FacetView

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this AdditionalFacetView.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AdditionalFacetView.

Overrides:

toString in class FacetView

check

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

Checks this AdditionalFacetView.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class FacetView

Throws:

com.exalead.util.TypedException

accept

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

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(AdditionalFacetView.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

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