public class ScopedWorkspaceFilter extends DefaultWorkspaceFilter
ATTR_VERSION, SUPPORTED_VERSION
Constructor and Description |
---|
ScopedWorkspaceFilter(DefaultWorkspaceFilter base,
boolean allow,
String[] roots) |
Modifier and Type | Method and Description |
---|---|
void |
add(PathFilterSet set)
Add a #PathFilterSet for nodes items.
|
void |
add(PathFilterSet nodeFilter,
PathFilterSet propFilter)
Add a #PathFilterSet for node and property items.
|
void |
addPropertyFilterSet(PathFilterSet set)
Add a #PathFilterSet for properties items.
|
boolean |
contains(String path)
Checks if the given node path is contained in this workspace filter.
|
boolean |
covers(String path)
Checks if the given node path is covered in this workspace filter.
|
static ScopedWorkspaceFilter |
createApplicationScoped(DefaultWorkspaceFilter base) |
static ScopedWorkspaceFilter |
createContentScoped(DefaultWorkspaceFilter base) |
void |
dump(DumpContext ctx,
boolean isLast)
Dumps some human readable information using the given context.
|
void |
dumpCoverage(Node rootNode,
ProgressTrackerListener listener)
Dumps the coverage of this filter against the given node to the listener.
|
void |
dumpCoverage(Session session,
ProgressTrackerListener listener,
boolean skipJcrContent)
Dumps the coverage of this filter using the given session.
|
PathFilterSet |
getCoveringFilterSet(String path)
Returns the filter set that covers the respective node path
|
List<PathFilterSet> |
getFilterSets()
Returns a list of path filter sets for node items.
|
ImportMode |
getImportMode(String path)
Returns the import mode for the given node path.
|
List<PathFilterSet> |
getPropertyFilterSets()
Returns a list of path filter sets for property items.
|
InputStream |
getSource()
Returns the source xml that constructs this filter
It is the obligation of the caller to close the returned input stream.
|
String |
getSourceAsString()
Returns the source xml that constructs this filter
|
boolean |
isAncestor(String path)
Checks if the given node path is an ancestor of any of the filter sets.
|
boolean |
isGloballyIgnored(String path)
Checks if the given node path is globally ignored.
|
void |
load(File file)
Loads the workspace filter from the given file
|
void |
load(InputStream in)
Loads the workspace filter from the given input source.
|
void |
resetSource()
Reset the source content to a null state.
|
void |
setGlobalIgnored(PathFilter ignored) |
void |
setImportMode(ImportMode importMode) |
WorkspaceFilter |
translate(PathMapping mapping)
Translates this workspace filter using the given path mapping.
|
equals, hashCode, load, toString
public ScopedWorkspaceFilter(DefaultWorkspaceFilter base, boolean allow, String[] roots)
public static ScopedWorkspaceFilter createApplicationScoped(DefaultWorkspaceFilter base)
public static ScopedWorkspaceFilter createContentScoped(DefaultWorkspaceFilter base)
public void add(PathFilterSet set)
DefaultWorkspaceFilter
add
in class DefaultWorkspaceFilter
set
- the set of filters to add.public void add(PathFilterSet nodeFilter, PathFilterSet propFilter)
DefaultWorkspaceFilter
add
in class DefaultWorkspaceFilter
nodeFilter
- the set of filters to add.propFilter
- the set of filters to add.public void addPropertyFilterSet(PathFilterSet set)
DefaultWorkspaceFilter
addPropertyFilterSet
in class DefaultWorkspaceFilter
set
- the set of filters to add.public List<PathFilterSet> getFilterSets()
DefaultWorkspaceFilter
getFilterSets
in interface WorkspaceFilter
getFilterSets
in class DefaultWorkspaceFilter
public List<PathFilterSet> getPropertyFilterSets()
DefaultWorkspaceFilter
getPropertyFilterSets
in interface WorkspaceFilter
getPropertyFilterSets
in class DefaultWorkspaceFilter
public PathFilterSet getCoveringFilterSet(String path)
DefaultWorkspaceFilter
getCoveringFilterSet
in interface WorkspaceFilter
getCoveringFilterSet
in class DefaultWorkspaceFilter
path
- the pathnull
public ImportMode getImportMode(String path)
DefaultWorkspaceFilter
getImportMode
in interface WorkspaceFilter
getImportMode
in class DefaultWorkspaceFilter
path
- path to checkImportMode.REPLACE
if the given path
is not covered by this filter.public void setImportMode(ImportMode importMode)
setImportMode
in class DefaultWorkspaceFilter
public boolean contains(String path)
DefaultWorkspaceFilter
true
if any of the filter sets contain the path
and it's not globally ignored.contains
in interface WorkspaceFilter
contains
in class DefaultWorkspaceFilter
path
- to checktrue
if the given path is included in this filter.public boolean covers(String path)
DefaultWorkspaceFilter
true
if at least one of the sets covers
the path and is not globally ignored.covers
in interface WorkspaceFilter
covers
in class DefaultWorkspaceFilter
path
- the pathto checktrue
if the given path is covered by this filter.public boolean isAncestor(String path)
DefaultWorkspaceFilter
isAncestor
in interface WorkspaceFilter
isAncestor
in class DefaultWorkspaceFilter
path
- the item to checktrue
if the given item is an ancestorpublic boolean isGloballyIgnored(String path)
DefaultWorkspaceFilter
isGloballyIgnored
in interface WorkspaceFilter
isGloballyIgnored
in class DefaultWorkspaceFilter
path
- the path to check.true
if the item is globally ignored.public WorkspaceFilter translate(PathMapping mapping)
DefaultWorkspaceFilter
translate
in interface WorkspaceFilter
translate
in class DefaultWorkspaceFilter
mapping
- the path mappingpublic void load(File file) throws IOException, ConfigurationException
DefaultWorkspaceFilter
load
in class DefaultWorkspaceFilter
file
- sourceIOException
- if an I/O error occursConfigurationException
- if the source is not validpublic InputStream getSource()
DefaultWorkspaceFilter
getSource
in interface WorkspaceFilter
getSource
in class DefaultWorkspaceFilter
public String getSourceAsString()
DefaultWorkspaceFilter
getSourceAsString
in interface WorkspaceFilter
getSourceAsString
in class DefaultWorkspaceFilter
public void load(InputStream in) throws IOException, ConfigurationException
DefaultWorkspaceFilter
The specified stream remains open after this method returns.
load
in class DefaultWorkspaceFilter
in
- sourceIOException
- if an I/O error occursConfigurationException
- if the source is not validpublic void dump(DumpContext ctx, boolean isLast)
DefaultWorkspaceFilter
dump
in interface Dumpable
dump
in class DefaultWorkspaceFilter
ctx
- the dump contextisLast
- specifies if this is the last element to dump on this levelpublic void resetSource()
DefaultWorkspaceFilter
resetSource
in class DefaultWorkspaceFilter
public void setGlobalIgnored(PathFilter ignored)
setGlobalIgnored
in class DefaultWorkspaceFilter
public void dumpCoverage(Node rootNode, ProgressTrackerListener listener) throws RepositoryException
DefaultWorkspaceFilter
dumpCoverage
in interface WorkspaceFilter
dumpCoverage
in class DefaultWorkspaceFilter
rootNode
- root nodelistener
- listenerRepositoryException
- if an error occurspublic void dumpCoverage(Session session, ProgressTrackerListener listener, boolean skipJcrContent) throws RepositoryException
DefaultWorkspaceFilter
skipJcrContent
is true
the jcr:content nodes are excluded from traversal and reporting.dumpCoverage
in interface WorkspaceFilter
dumpCoverage
in class DefaultWorkspaceFilter
session
- sessionlistener
- listener to report progressskipJcrContent
- true
to skip jcr:content nodesRepositoryException
- if an error occursCopyright © 2010 - 2020 Adobe. All Rights Reserved