com.adobe.cq.social.ugc.api

Class UgcFilter

java.lang.Object

com.adobe.cq.social.ugc.api.UgcFilter

Direct Known Subclasses:

MessageFilter

public class UgcFilter
extends java.lang.Object

The UGC filter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UgcFilter.Comparison Deprecated. Use ComparisonType instead.
class	UgcFilter.PropertyFilter Deprecated. Use addConstraint instead of creating PropertyFilters.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CONTENT_TYPE The default content type.

Constructor Summary

Constructors

Constructor and Description
UgcFilter() Creates a new UgcFilter with the default content type.
UgcFilter(java.lang.String contentType) Creates a new UgcFilter with the given content type.

Method Summary

Modifier and Type	Method and Description
void	accept(ConstraintVisitor constraintVisitor) Accept the constraint visitor.
void	addConstraint(Constraint constraint) Adds a constraint to this UgcFilter.
void	addSort(UgcSort sort) Add a UgcSort to the list.
void	and(Constraint constraint) A Convenience method which will set the operator of the given constraint to AND and add it to this UgcFilter.
static java.lang.String	escape(java.lang.String str) Escape any special characters in the specified string by a preceding \.
void	filterAndByConstraintGroup(java.lang.String constraintGroupName, java.lang.String propertyName, java.lang.String propertyValue, UgcFilter.Comparison comparison) Deprecated. Use and with a ValueConstraint instead.
void	filterAndByProperty(java.lang.String propertyName, java.lang.String propertyValue, UgcFilter.Comparison comparison) Deprecated. Use and with a ValueConstraint instead.
void	filterByPath(java.lang.String parentPath) Deprecated. Use addConstraint with PathConstraint instead.
void	filterContentType(java.lang.String ct) Deprecated. Use addConstraint with PathConstraint instead. Set the content type to filter.
void	filterOrByConstraintGroup(java.lang.String constraintGroupName, java.lang.String propertyName, java.lang.String propertyValue, UgcFilter.Comparison comparison) Deprecated. Use or with a ValueConstraint instead.
void	filterOrByProperty(java.lang.String propertyName, java.lang.String propertyValue, UgcFilter.Comparison comparison) Deprecated. Use or with a ValueConstraint instead.
java.util.Map<java.lang.String,java.util.List<UgcFilter.PropertyFilter>>	getAndPropertyFilters() Deprecated. Use getConstraints instead.
java.util.Collection<Constraint>	getConstraints() Gets all constraints which have been added to this UgcFilter.
java.lang.String	getContentFilter() Deprecated. Use getContentType instead.
java.lang.String	getContentType() Returns the content type for this UgcFilter.
java.util.Map<java.lang.String,java.util.List<UgcFilter.PropertyFilter>>	getOrPropertyFilters() Deprecated. Use getConstraints instead.
java.lang.String[]	getPathFilters() Deprecated. Use getConstraints() getConstraints} instead.
UgcSort	getSort() Deprecated. Use the getSortOrder method.
java.util.List<UgcSort>	getSortOrder() Gets the sort order of this UgcFilter.
java.util.Map<java.lang.String,java.lang.Object>	getVariables() Return the variable map.
boolean	hasConstraints() Gets whether or not the UgcFilter has constraints.
boolean	hasPropertyFilters() Deprecated. Use hasConstraints instead.
boolean	hasVariables() Gets whether or not variables have been added to this UgcFilter.
boolean	isContentTypeFiltered() Deprecated. Use getConstraints() getConstraints} instead.
boolean	isPathFiltered() Deprecated. use hasConstraints instead.
boolean	isSorted() Gets whether or not this UgcFilter is sorted.
void	or(Constraint constraint) A Convenience method which will set the operator of the given constraint to OR and add it to this UgcFilter.
void	setContentType(java.lang.String contentType) Set the node type to be matched.
<T> void	setVariableValue(java.lang.String variableName, T variable) Set a variable.
void	sortByAscending(java.lang.String propertyName) Deprecated. Use the addSort method.
void	sortByDescending(java.lang.String propertyName) Deprecated. Use the addSort method.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTENT_TYPE

public static final java.lang.String DEFAULT_CONTENT_TYPE

The default content type.

See Also:

Constant Field Values

Constructor Detail

UgcFilter

public UgcFilter()

Creates a new UgcFilter with the default content type.

UgcFilter

public UgcFilter(java.lang.String contentType)

Creates a new UgcFilter with the given content type.

Parameters:

contentType - String containing the given content type.

Method Detail

addConstraint

public void addConstraint(Constraint constraint)

Adds a constraint to this UgcFilter.

Parameters:

constraint - Constraint to add.

and

public void and(Constraint constraint)

A Convenience method which will set the operator of the given constraint to AND and add it to this UgcFilter.

Parameters:

constraint - Constraint to add.

or

public void or(Constraint constraint)

A Convenience method which will set the operator of the given constraint to OR and add it to this UgcFilter.

Parameters:

constraint - Constraint to add.

hasConstraints

public boolean hasConstraints()

Gets whether or not the UgcFilter has constraints.

Returns:

True if the UgcFilter has constraints, false otherwise.

getConstraints

public java.util.Collection<Constraint> getConstraints()

Gets all constraints which have been added to this UgcFilter. An empty collection is returned if no constraints have been added.

Returns:

A Collection containing all constraints that have been added to this UgcFilter.

addSort

public void addSort(UgcSort sort)

Add a UgcSort to the list.

Parameters:

sort - the UgcSort to add.

getContentType

public java.lang.String getContentType()

Returns the content type for this UgcFilter. This is the nodetype and is only useful with JSRP. For cross-SRP code, you should use a ValueConstraint with the sling:resourceType

Returns:

String containing the content type for this UgcFilter.

setContentType

public void setContentType(java.lang.String contentType)

Set the node type to be matched. This is only useful with JSRP. For cross-SRP code, you should use a ValueConstraint with the sling:resourceType

Parameters:

contentType - the content type to use

escape

public static java.lang.String escape(java.lang.String str)

Escape any special characters in the specified string by a preceding \.

Parameters:

str - the input string

Returns:

a String where those characters that QueryParser expects to be escaped are escaped by a preceding \

isSorted

public boolean isSorted()

Gets whether or not this UgcFilter is sorted.

Returns:

True if this UgcFilter is sorted, false otherwise.

getSortOrder

public java.util.List<UgcSort> getSortOrder()

Gets the sort order of this UgcFilter.

Returns:

A List of UgcSort objects or null if the UgcFilter is not sorted.

hasVariables

public boolean hasVariables()

Gets whether or not variables have been added to this UgcFilter.

Returns:

True if the UgcFilter has a variable, false otherwise.

setVariableValue

public <T> void setVariableValue(java.lang.String variableName,
                                 T variable)

Set a variable.

Type Parameters:

T - the type of variable.

Parameters:

variableName - the name of the variable.

variable - the value of the variable.

getVariables

public java.util.Map<java.lang.String,java.lang.Object> getVariables()

Return the variable map.

Returns:

the variable map.

accept

public void accept(ConstraintVisitor constraintVisitor)

Accept the constraint visitor.

Parameters:

constraintVisitor - the ConstraintVisitor.

getSort

@Deprecated
public UgcSort getSort()

Deprecated. Use the getSortOrder method.

Returns:

the UgcSort.

sortByAscending

@Deprecated
public void sortByAscending(java.lang.String propertyName)

Deprecated. Use the addSort method.

Due to a bug and for backwards compatibility reasons this method actually adds a descending sort. addSort should be used instead.

Parameters:

propertyName - Name of the property to sort.

sortByDescending

@Deprecated
public void sortByDescending(java.lang.String propertyName)

Deprecated. Use the addSort method.

Due to a bug and for backwards compatibility reasons this method actually adds a ascending sort. addSort should be used instead.

Parameters:

propertyName - Name of the property to sort.

filterOrByProperty

@Deprecated
public void filterOrByProperty(java.lang.String propertyName,
                                           java.lang.String propertyValue,
                                           UgcFilter.Comparison comparison)

Deprecated. Use or with a ValueConstraint instead.

Parameters:

propertyName - the name of the property.

propertyValue - the property value.

comparison - the type of comparison.

filterOrByConstraintGroup

@Deprecated
public void filterOrByConstraintGroup(java.lang.String constraintGroupName,
                                                  java.lang.String propertyName,
                                                  java.lang.String propertyValue,
                                                  UgcFilter.Comparison comparison)

Deprecated. Use or with a ValueConstraint instead.

Parameters:

constraintGroupName - the name of the constraint group.

propertyName - the name of the property.

propertyValue - the property value.

comparison - the type of comparison.

filterAndByProperty

@Deprecated
public void filterAndByProperty(java.lang.String propertyName,
                                            java.lang.String propertyValue,
                                            UgcFilter.Comparison comparison)

Deprecated. Use and with a ValueConstraint instead.

Parameters:

propertyName - the name of the property.

propertyValue - the property value.

comparison - the type of comparison.

filterAndByConstraintGroup

@Deprecated
public void filterAndByConstraintGroup(java.lang.String constraintGroupName,
                                                   java.lang.String propertyName,
                                                   java.lang.String propertyValue,
                                                   UgcFilter.Comparison comparison)

Deprecated. Use and with a ValueConstraint instead.

Parameters:

constraintGroupName - the name of the constraint group.

propertyName - the name of the property.

propertyValue - the property value.

comparison - the type of comparison.

hasPropertyFilters

@Deprecated
public boolean hasPropertyFilters()

Deprecated. Use hasConstraints instead.

Returns:

true if there are property filters.

getOrPropertyFilters

@Deprecated
public java.util.Map<java.lang.String,java.util.List<UgcFilter.PropertyFilter>> getOrPropertyFilters()

Deprecated. Use getConstraints instead.

Returns:

the map of OR property filters.

getAndPropertyFilters

@Deprecated
public java.util.Map<java.lang.String,java.util.List<UgcFilter.PropertyFilter>> getAndPropertyFilters()

Deprecated. Use getConstraints instead.

Returns:

the map of AND property filters.

filterContentType

@Deprecated
public void filterContentType(java.lang.String ct)

Deprecated. Use addConstraint with PathConstraint instead. Set the content type to filter.

Parameters:

ct - the content type to filter.

isContentTypeFiltered

@Deprecated
public boolean isContentTypeFiltered()

Deprecated. Use getConstraints() getConstraints} instead.

Returns:

true if content type is filtered.

getContentFilter

@Deprecated
public java.lang.String getContentFilter()

Deprecated. Use getContentType instead.

Returns:

the content type filter.

filterByPath

@Deprecated
public void filterByPath(java.lang.String parentPath)

Deprecated. Use addConstraint with PathConstraint instead.

Parameters:

parentPath - the path of the parent to filter.

isPathFiltered

@Deprecated
public boolean isPathFiltered()

Deprecated. use hasConstraints instead.

Returns:

true if the path is filtered.

getPathFilters

@Deprecated
public java.lang.String[] getPathFilters()

Deprecated. Use getConstraints() getConstraints} instead.

Returns:

the array of path filters.