Uses of Class
com.composum.sling.core.service.PathReferencesService.Options

Packages that use PathReferencesService.Options

Package	Description
com.composum.sling.core.service
com.composum.sling.core.service.impl

Uses of PathReferencesService.Options in com.composum.sling.core.service

Methods in com.composum.sling.core.service that return PathReferencesService.Options

Modifier and Type	Method	Description
PathReferencesService.Options	PathReferencesService.Options.basePath(@NotNull String path)	the 'base path' is used to complete a relative path or to determine the relative variant of an absolute path; if in a referer search a relative path is searched this base path is prepended to build the absolute path; if an absolute path is searched the base path is used to build the relative variant of the absolute path if this absolutre path starts with the base path
PathReferencesService.Options	PathReferencesService.Options.childrenOnly(boolean flag)	if 'true' a search for subpages of the specified path to search is executed
PathReferencesService.Options	PathReferencesService.Options.contentPath(@NotNull String name)	an optional relative content path; maybe 'null'
PathReferencesService.Options	PathReferencesService.Options.findRichText(boolean flag)	if 'true' the path is searched also as part of rich text properties (contains a pattern like '="{path}"')
PathReferencesService.Options	PathReferencesService.Options.includeChildren(boolean flag)	if 'true' all resources wich are referencing paths starting with the searched path are found
PathReferencesService.Options	PathReferencesService.Options.primaryType(@NotNull String name)	the primary type of the searched referrers; maybe 'null'
PathReferencesService.Options	PathReferencesService.Options.propertyName(@NotNull String name)	the name of the property which is storing the reference; maybe 'null'
PathReferencesService.Options	PathReferencesService.Options.resourceName(@NotNull String name)	the node name of the searched referrers; maybe 'null'
PathReferencesService.Options	PathReferencesService.Options.resourceType(@NotNull String name)	the Sling resource type of the searched referrers; maybe 'null'
PathReferencesService.Options	PathReferencesService.Options.useAbsolutePath(boolean flag)	if 'true' the absolute path variant of the searched path is checked
PathReferencesService.Options	PathReferencesService.Options.useRelativePath(boolean flag)	if 'true' the relative path variant of the searched path is checked
PathReferencesService.Options	PathReferencesService.Options.useTextSearch(boolean flag)	if 'true' the path is searched using the fulltext search (jcr:contains())

Methods in com.composum.sling.core.service with parameters of type PathReferencesService.Options

Modifier and Type	Method	Description
@NotNull PathReferencesService.HitIterator	PathReferencesService.findReferences(@NotNull org.apache.sling.api.resource.ResourceResolver resolver, @NotNull PathReferencesService.Options options, @NotNull String searchRoot, @NotNull String path)	searches resources which are referencing the given path

Uses of PathReferencesService.Options in com.composum.sling.core.service.impl

Fields in com.composum.sling.core.service.impl declared as PathReferencesService.Options

Modifier and Type	Field	Description
protected PathReferencesService.Options	PathReferencesServiceImpl.HitIteratorImpl.options

Methods in com.composum.sling.core.service.impl with parameters of type PathReferencesService.Options

Modifier and Type	Method	Description
protected void	PathReferencesServiceImpl.addPathExpression(@NotNull PathReferencesService.Options options, @NotNull StringBuilder queryBuilder, @NotNull String propertyName, @NotNull String path)
@NotNull PathReferencesService.HitIterator	PathReferencesServiceImpl.findReferences(@NotNull org.apache.sling.api.resource.ResourceResolver resolver, @NotNull PathReferencesService.Options options, @NotNull String searchRoot, @NotNull String path)

Constructors in com.composum.sling.core.service.impl with parameters of type PathReferencesService.Options

Constructor	Description
HitIteratorImpl(@NotNull PathReferencesService.Options options, @NotNull String queryString, @NotNull String absPath, @NotNull String relPath, @NotNull Throwable throwable)
HitIteratorImpl(@NotNull PathReferencesService.Options options, @NotNull String queryString, @NotNull String absPath, @NotNull String relPath, @NotNull Iterator<org.apache.sling.api.resource.Resource> searchResult)