Package com.adobe.acs.commons.analysis.jcrchecksum.impl.options

Class AbstractChecksumGeneratorOptions

java.lang.Object

com.adobe.acs.commons.analysis.jcrchecksum.impl.options.AbstractChecksumGeneratorOptions

All Implemented Interfaces:

ChecksumGeneratorOptions

Direct Known Subclasses:

CustomChecksumGeneratorOptions, DefaultChecksumGeneratorOptions, RequestChecksumGeneratorOptions

@ProviderType
public abstract class AbstractChecksumGeneratorOptions
extends Object
implements ChecksumGeneratorOptions

Provides options to configure how to generate checksums using ChecksumGenerator.

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	excludedNodeNames
protected Set<String>	excludedNodeTypes
protected Set<String>	excludedProperties
protected Set<String>	excludedSubTrees
protected Set<String>	includedNodeTypes
protected Set<String>	sortedProperties

Fields inherited from interface com.adobe.acs.commons.analysis.jcrchecksum.ChecksumGeneratorOptions

DATA, NODE_NAME_EXCLUDES, NODE_TYPE_EXCLUDES, NODES_TYPES, PATHS, PROPERTY_EXCLUDES, QUERY, QUERY_TYPE, SORTED_PROPERTIES, SUB_TREE_EXCLUDES

Constructor Summary

Constructors

Constructor	Description
AbstractChecksumGeneratorOptions()

Method Summary

Modifier and Type	Method	Description
void	addExcludedNodeNames(String... data)
void	addExcludedNodeTypes(String... data)
void	addExcludedProperties(String... data)
void	addExcludedSubTrees(String... data)
void	addIncludedNodeTypes(String... data)
void	addSortedProperties(String... data)
Set<String>	getExcludedNodeNames()
Set<String>	getExcludedNodeTypes()
Set<String>	getExcludedProperties()
Set<String>	getExcludedSubTrees()
Set<String>	getIncludedNodeTypes()	For a node to be checksumable, its primaryType must exists in getIncludedNodesTypes() and not exist in getExcludedNodeTypes().
Set<String>	getSortedProperties()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

includedNodeTypes

protected Set<String> includedNodeTypes

excludedNodeTypes

protected Set<String> excludedNodeTypes

excludedProperties

protected Set<String> excludedProperties

sortedProperties

protected Set<String> sortedProperties

excludedNodeNames

protected Set<String> excludedNodeNames

excludedSubTrees

protected Set<String> excludedSubTrees

Constructor Detail

AbstractChecksumGeneratorOptions

public AbstractChecksumGeneratorOptions()

Method Detail

addIncludedNodeTypes

public void addIncludedNodeTypes(String... data)

getIncludedNodeTypes

public Set<String> getIncludedNodeTypes()

Description copied from interface: ChecksumGeneratorOptions

For a node to be checksumable, its primaryType must exists in getIncludedNodesTypes() and not exist in getExcludedNodeTypes().

Specified by:

getIncludedNodeTypes in interface ChecksumGeneratorOptions

Returns:

the nodes types which are candidates for aggregation.

addExcludedNodeTypes

public void addExcludedNodeTypes(String... data)

getExcludedNodeTypes

public Set<String> getExcludedNodeTypes()

Specified by:

getExcludedNodeTypes in interface ChecksumGeneratorOptions

Returns:

the node types which are not candidates for aggregation and cannot be aggregated under aggregation candidates.

addExcludedProperties

public void addExcludedProperties(String... data)

getExcludedProperties

public Set<String> getExcludedProperties()

Specified by:

getExcludedProperties in interface ChecksumGeneratorOptions

Returns:

the property names that should not be included as part of the checksum hash

addSortedProperties

public void addSortedProperties(String... data)

getSortedProperties

public Set<String> getSortedProperties()

Specified by:

getSortedProperties in interface ChecksumGeneratorOptions

Returns:

the property names whose multi-value order as defined in the JCR should be respected.

getExcludedNodeNames

public Set<String> getExcludedNodeNames()

Specified by:

getExcludedNodeNames in interface ChecksumGeneratorOptions

Returns:

the nodeNames to exclude (sub-nodes WILL be traverse/checksumed)

addExcludedNodeNames

public void addExcludedNodeNames(String... data)

getExcludedSubTrees

public Set<String> getExcludedSubTrees()

Specified by:

getExcludedSubTrees in interface ChecksumGeneratorOptions

Returns:

the named node subTrees to exclude (the matching node and any sub-nodes will NOT be traversed/checksumed)

addExcludedSubTrees

public void addExcludedSubTrees(String... data)

toString

public String toString()

Overrides:

toString in class Object