com.day.cq.contentbus

Class HierarchicalPackageFilter

java.lang.Object

com.day.cq.contentbus.HierarchicalPackageFilter

All Implemented Interfaces:

PackageFilter

public class HierarchicalPackageFilter
extends java.lang.Object
implements PackageFilter

The HierarchicalPackageFilter implements a PackageFilter that matches all handles below the specified one or is equal to the specified one. For example:
A HierarchicalPackageFilter is built with /content/en.
Then the following handles will match:

/conent/en
/content/en/company
/content/en/company/finance
/content/en/people
etc.

Since:

bandicoot

Constructor Summary

Constructors

Constructor and Description
HierarchicalPackageFilter(java.lang.String handle) Creates a new HierarchicalPackageFilter with the specified handle.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns true if this HierarchicalPackageFilter is equal to another object obj.
java.lang.String[]	getTraversalStartPoint() Returns the 'best' starting points for a traversal, in order to get all handles that are covered by this filter.
int	hashCode() Returns the hashCode of this HierarchicalPackageFilter.
boolean	matches(Page page) Compute if the handle of the page and eventual its content matches the rules of the filter.
boolean	matches(java.lang.String handle) Compute if the handle matches the rules of the filter.
boolean	matches(Ticket ticket, java.lang.String handle) Compute if the handle and eventual its content matches the rules of the filter.
java.lang.String	toString() Returns a String representation of this HierarchicalPackageFilter.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HierarchicalPackageFilter

public HierarchicalPackageFilter(java.lang.String handle)

Creates a new HierarchicalPackageFilter with the specified handle.

Parameters:

handle - the handle to match against

Method Detail

matches

public boolean matches(java.lang.String handle)

Description copied from interface: PackageFilter

Compute if the handle matches the rules of the filter.

Specified by:

matches in interface PackageFilter

Parameters:

handle - handle to be checked

Returns:

true if the handle matches the rules of the filter; false otherwise.

See Also:

PackageFilter.matches(String)

matches

public boolean matches(Ticket ticket,
              java.lang.String handle)

Description copied from interface: PackageFilter

Compute if the handle and eventual its content matches the rules of the filter.

Specified by:

matches in interface PackageFilter

Parameters:

ticket - ticket for eventual contentbus accesses

handle - handle to be checked

Returns:

true if the handle matches the rules of the filter; false otherwise.

See Also:

PackageFilter.matches(Ticket, String)

matches

public boolean matches(Page page)

Description copied from interface: PackageFilter

Compute if the handle of the page and eventual its content matches the rules of the filter.

Specified by:

matches in interface PackageFilter

Parameters:

page - page to be checked

Returns:

true if the handle matches the rules of the filter; false otherwise.

See Also:

PackageFilter.matches(Page)

getTraversalStartPoint

public java.lang.String[] getTraversalStartPoint()

Description copied from interface: PackageFilter

Returns the 'best' starting points for a traversal, in order to get all handles that are covered by this filter. the starting points may not match the rules of the filter.

Specified by:

getTraversalStartPoint in interface PackageFilter

Returns:

an array of handles or null if not starting points can be given.

See Also:

PackageFilter.getTraversalStartPoint()

toString

public java.lang.String toString()

Returns a String representation of this HierarchicalPackageFilter.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this HierarchicalPackageFilter.

equals

public boolean equals(java.lang.Object obj)

Returns true if this HierarchicalPackageFilter is equal to another object obj.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to test for equality.

Returns:

true if this HierarchicalPackageFilter is equal to another object obj; false otherwise.

hashCode

public int hashCode()

Returns the hashCode of this HierarchicalPackageFilter.

Overrides:

hashCode in class java.lang.Object

Returns:

the hashCode of this HierarchicalPackageFilter.