Method Detail

• getFilterSets

  List<PathFilterSet> getFilterSets()

  Returns a list of path filter sets.

  Returns:

  the list of path filter sets.

• getCoveringFilterSet

  PathFilterSet getCoveringFilterSet(String path)

  Returns the filter set that covers the respective path

  Parameters:

  path - the path

  Returns:

  the filter set or null

• getImportMode

  ImportMode getImportMode(String path)

  Returns the import mode for the given path.

  Parameters:

  path - path to check

  Returns:

  the import mode or ImportMode.REPLACE if the given path is not covered by this filter.

• contains

  boolean contains(String path)

  Checks if the given path is contained in this workspace filter. It returns true if any of the filter sets contain the path and it's not globally ignored.

  Parameters:

  path - to check

  Returns:

  true if the given path is included in this filter.

• covers

  boolean covers(String path)

  Checks if the given path is covered in this workspace filter. It only returns true if at least one of the sets covers the path and is not globally ignored.

  Parameters:

  path - the pathto check

  Returns:

  true if the given path is covered by this filter.

• isAncestor

  boolean isAncestor(String path)

  Checks if the given path is an ancestor of any of the filter sets.

  Parameters:

  path - the item to check

  Returns:

  true if the given item is an ancestor

• isGloballyIgnored

  boolean isGloballyIgnored(String path)

  Checks if the given path is globally ignored.

  Parameters:

  path - the path to check.

  Returns:

  true if the item is globally ignored.

• getSource

  InputStream getSource()

  Returns the source xml that constructs this filter

  Returns:

  the source xml

• getSourceAsString

  String getSourceAsString()

  Returns the source xml that constructs this filter

  Returns:

  the source xml

• translate

  WorkspaceFilter translate(PathMapping mapping)

  Translates this workspace filter using the given path mapping.

  Parameters:

  mapping - the path mapping

  Returns:

  a new workspace filter

  Since:

  2.4.10

• dumpCoverage

  void dumpCoverage(javax.jcr.Node rootNode,
                  ProgressTrackerListener listener)
                    throws javax.jcr.RepositoryException

  Dumps the coverage of this filter against the given node to the listener.

  Parameters:

  rootNode - root node

  listener - listener

  Throws:

  javax.jcr.RepositoryException - if an error occurs

• dumpCoverage

  void dumpCoverage(javax.jcr.Session session,
                  ProgressTrackerListener listener,
                  boolean skipJcrContent)
                    throws javax.jcr.RepositoryException

  Dumps the coverage of this filter using the given session. The traversal starts at the common ancestor of all filter sets. If skipJcrContent is true the jcr:content nodes are excluded from traversal and reporting.

  Parameters:

  session - session

  listener - listener to report progress

  skipJcrContent - true to skip jcr:content nodes

  Throws:

  javax.jcr.RepositoryException - if an error occurs