public interface Filter
A property restriction could be that the property must exist, or that the property value has to be within a certain range.
A path restriction could be a restriction to a certain subtree, a parent of a certain path, or equality to a certain path.
Modifier and Type | Interface and Description |
---|---|
static class |
Filter.PathRestriction
The path restriction type.
|
static class |
Filter.PropertyRestriction
A restriction for a property.
|
Modifier and Type | Field and Description |
---|---|
static Filter |
EMPTY_FILTER |
Modifier and Type | Method and Description |
---|---|
boolean |
containsNativeConstraint()
Whether the filter contains a native condition.
|
Collection<String> |
getFulltextConditions()
Deprecated.
|
FullTextExpression |
getFullTextConstraint()
Get the fulltext search condition expression, if any.
|
@NotNull Set<String> |
getMixinTypes()
Returns the names of all matching mixin node types.
|
@Nullable String |
getNodeType()
Returns the name of the filter node type.
|
String |
getPath()
Get the path, or "/" if there is no path restriction set.
|
String |
getPathPlan()
Get the plan for the path.
|
Filter.PathRestriction |
getPathRestriction()
Get the path restriction type.
|
@NotNull Set<String> |
getPrimaryTypes()
Returns the names of all matching primary node types.
|
Filter.PropertyRestriction |
getPropertyRestriction(String propertyName)
Get the most restrictive property restriction for the given property, if
any.
|
Collection<Filter.PropertyRestriction> |
getPropertyRestrictions()
Get the list of property restrictions, if any.
|
List<Filter.PropertyRestriction> |
getPropertyRestrictions(String propertyName)
Get the all property restriction for the given property.
|
QueryLimits |
getQueryLimits() |
@Nullable String |
getQueryStatement()
Get the complete query statement.
|
@NotNull Set<String> |
getSupertypes()
Returns the names of the filter node type and all its supertypes.
|
boolean |
isAccessible(String path)
check whether a certain (valid) path is accessible (can be read) from the user associated with the query Session
|
boolean |
isAlwaysFalse()
If the filter condition can not possibly match any row, due to a
contradiction in the query (for example "x=1 and x=2").
|
boolean |
matchesAllTypes()
Checks whether nodes of all types can match this filter.
|
static final Filter EMPTY_FILTER
Collection<Filter.PropertyRestriction> getPropertyRestrictions()
@Deprecated Collection<String> getFulltextConditions()
FullTextExpression getFullTextConstraint()
QueryLimits getQueryLimits()
boolean isAccessible(String path)
path
- a valid JCR pathtrue
if path can be read by the calling user, false
otherwise.boolean containsNativeConstraint()
Filter.PropertyRestriction getPropertyRestriction(String propertyName)
propertyName
- the property nameList<Filter.PropertyRestriction> getPropertyRestrictions(String propertyName)
propertyName
- the property nameFilter.PathRestriction getPathRestriction()
String getPath()
String getPathPlan()
@Nullable @Nullable String getNodeType()
boolean matchesAllTypes()
true
iff there are no type restrictions@NotNull @NotNull Set<String> getSupertypes()
@NotNull @NotNull Set<String> getPrimaryTypes()
@NotNull @NotNull Set<String> getMixinTypes()
@Nullable @Nullable String getQueryStatement()
boolean isAlwaysFalse()
Copyright © 2010 - 2020 Adobe. All Rights Reserved