com.loop54.model.request.parameters.facets

Class FacetParameter

java.lang.Object

com.loop54.model.request.parameters.facets.FacetParameter

Direct Known Subclasses:

DistinctFacetParameter, RangeFacetParameter

public abstract class FacetParameter
extends java.lang.Object

Used for faceting an entity collection based on the attributes of the entities.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	attributeName The name of the attribute on the entities to facet the result on.
java.lang.String	name Name of the facet to return to the client.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FacetParameter(java.lang.String attributeName)

Method Summary

Modifier and Type	Method and Description
abstract FacetType	getType() Type of the facet.

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

Name of the facet to return to the client. Can be a 'friendly' name to show to the user. If not set the attributeName will be used.

attributeName

public final java.lang.String attributeName

The name of the attribute on the entities to facet the result on. If the attribute does not exist on any entity, all entities will pass and an empty facet will be returned.

Constructor Detail

FacetParameter

protected FacetParameter(java.lang.String attributeName)

Method Detail

getType

public abstract FacetType getType()

Type of the facet. Range or Distinct.

Returns:

Type of the facet parameter