@Version(value="1.4.0")

Package com.adobe.cq.social.ugc.api

This package contains facilities to search for user generated content.

See: Description

Interface Summary

Interface	Description
Constraint	Defines a restriction as part of a query.
ConstraintVisitor	ConstraintVisitor implementations can be used to travers a set of constraints.
RelatedSearch	Interface for performing related search and faceted search.
SearchResults<T>	Search results interface.
UgcNodeIndexerExtension	Deprecated
UgcSearch	Interface for UGC search.

Class Summary

Class	Description
AbstractConstraint	AbstractConstraint provides implementations for functionality common to most Constraints.
AbstractPropertyConstraint	AbstractPropertyConstraint provides functionality common to constraints which apply to a specific property.
AbstractUgcNodeIndexerExtension	Deprecated
ConstraintGroup	Defines a grouping of constraints.
DefaultConstraintVisitor	DefaultConstraintVisitor provides empty no-op method implementations for all ConstraintVisitor methods.
FullTextConstraint	FullTextConstraint restricts the results to a specific full text expression.
PathConstraint	PathConstraint defines a constraint on the path of a node.
RangeConstraint<T>	RangeConstraint is a property constraint which restricts the value of a property to a specific range.
SetConstraint<T>	SetConstraint is a property constraint which restricts the value of a property to one of a set of values.
UgcCategoryProperty	A UGC catagory property.
UgcFilter	The UGC filter.
UgcFilterQueryWriter	Responsible for writing a UgcFilter as a JCR SQL2 query.
UgcIndexerUtil	Indexer utility methods.
UgcIndexProperty	An index property specified by index handers.
UgcSort	Used to specify sort direction.
ValueConstraint<T>	ValueConstraint is a property constraint which restricts the value of a property based on a ComparisonType and a value.

Enum Summary

Enum	Description
ComparisonType	Defines the type of comparison to use when comparing property values.
Operator	Defines how constraints are joined together.
PathConstraintType	Created with IntelliJ IDEA.
UgcFilter.Comparison	Deprecated Use ComparisonType instead.
UgcIndexProperty.Index	The index types.
UgcSort.Direction	Sort direction types.

Package com.adobe.cq.social.ugc.api Description

This package contains facilities to search for user generated content. It takes care of differences between different storage mechanisms. The UgcSearch class provides basic search capabilities, including filtering (via Constraint) and sorting. The RelatedSearch class provides more advanced search capabilities, including faceting.