net.adamcin.oakpal.webster

Class ChecklistExporter.Builder

java.lang.Object

net.adamcin.oakpal.webster.ChecklistExporter.Builder

Enclosing class:

ChecklistExporter

public static final class ChecklistExporter.Builder
extends Object

Builder for a ChecklistExporter, which is otherwise immutable.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ChecklistExporter	build() Create the new exporter instance.
ChecklistExporter.Builder	byNodeType(String... nodeTypes) Add an operation to export a set of roots returned by a nodetype query.
ChecklistExporter.Builder	byPath(String... paths) Add an operation to export a set of roots by individual paths.
ChecklistExporter.Builder	byQuery(String statement) Add an operation to export a set of roots returned by the specified JCR query.
ChecklistExporter.Builder	withExportNodeTypes(List<String> exportNodeTypes) To export node types that aren't necessarily referenced in exported forced roots or in a node type selector, list them here in the same format as you would in a node type selector.
ChecklistExporter.Builder	withJcrNamespaces(List<JcrNs> jcrNamespaces) Provide a list of JCR namespace prefix mappings to register or remap before performing the operations.
ChecklistExporter.Builder	withNodeTypeFilters(List<Rule> nodeTypeFilters) In situations where a checklist is only concerned with a subset of node types, use this method to exclude irrelevant types from the output.
ChecklistExporter.Builder	withScopePaths(List<Rule> scopePaths) Limit the scope of exported forced root paths using a list of Rule patterns.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

byPath

public ChecklistExporter.Builder byPath(String... paths)

Add an operation to export a set of roots by individual paths. If a specified path does not exist in the repository, a root will not be exported for it.

Parameters:

paths - the list of paths to export as forced roots

Returns:

this builder

byQuery

public ChecklistExporter.Builder byQuery(String statement)

Add an operation to export a set of roots returned by the specified JCR query. This query can be in either JCR-SQL2 or XPath language.

Parameters:

statement - the JCR query statement

Returns:

this builder

byNodeType

public ChecklistExporter.Builder byNodeType(String... nodeTypes)

Add an operation to export a set of roots returned by a nodetype query. By default, only nodes which are _explicitly_ typed with one of the specified node types are returned. If you also want to include nodes which are either _explicitly_ or _implicitly_ typed with a particular node type or one of its subtypes, you must prefix the type name with a "+", e.g. "+sling:Folder" instead of "sling:Folder".

Parameters:

nodeTypes - the list of JCR node types to query for

Returns:

this builder

withScopePaths

public ChecklistExporter.Builder withScopePaths(List<Rule> scopePaths)

Limit the scope of exported forced root paths using a list of Rule patterns. Paths which last-match an "INCLUDE" pattern are considered to be "in scope", which means they can be returned by the specified operations and/or replaced in existing checklists. Use EXCLUDE patterns to protect existing forced roots from being overwritten by a particular instance of ChecklistExporter.

Parameters:

scopePaths - the list of include/exclude patterns

Returns:

this builder

See Also:

Rules.lastMatch(List, String)

withNodeTypeFilters

public ChecklistExporter.Builder withNodeTypeFilters(List<Rule> nodeTypeFilters)

In situations where a checklist is only concerned with a subset of node types, use this method to exclude irrelevant types from the output. This is useful when trying to avoid introducing a dependency on an JCR namespace or CND that exists in a template repository for other purposes. For example, an EXCLUDE rule for "cq:.*" would exclude any types in the cq namespace.

Parameters:

nodeTypeFilters - the list of include/exclude patterns

Returns:

this builder

See Also:

Rules.lastMatch(List, String)

withJcrNamespaces

public ChecklistExporter.Builder withJcrNamespaces(List<JcrNs> jcrNamespaces)

Provide a list of JCR namespace prefix mappings to register or remap before performing the operations.

Parameters:

jcrNamespaces - the list of jcr namespace mappings

Returns:

this builder

withExportNodeTypes

public ChecklistExporter.Builder withExportNodeTypes(List<String> exportNodeTypes)

To export node types that aren't necessarily referenced in exported forced roots or in a node type selector, list them here in the same format as you would in a node type selector. These are also filtered by nodeTypeFilters, which makes sense if you select a broad supertype for export, but want to restrict the resulting exported subtypes to a particular namespace, or to exclude an enumerated list of subtypes.

Parameters:

exportNodeTypes - the list of JCR node types to export

Returns:

this builder

See Also:

byNodeType(String...)

build

public ChecklistExporter build()

Create the new exporter instance.

Returns:

the new ChecklistExporter instance