| org.apache.jetspeed.profiler.ProfileLocator
| ProfileLocator | | public interface ProfileLocator (Code) | | Profile Locators are used to locate profiled portal resources such as
pages, documents, and fragments. A locator contains properties describing
the actually resource to be located. Since the locator is based on properties
that are usually related to a user or other subject's profile, it is referred
to as a profile locator.
Profiles can be created from a normalized Profile Locator Path
The format of the path is name/value pairs of all property, separated by a path separator.
An example locator path:
page:default.psml:artist:al-stewart:song:on-the-border
path:/sports/football/nfl/chiefs:language:en
author:
David Sean Taylor
version:
$Id: ProfileLocator.java 516448 2007-03-09 16:25:47Z ate $ |
| Method Summary | |
| void | add(RuleCriterion criterion, boolean isControl, boolean isNavigation, String value)
Add a property based on a @link org.apache.jetspeed.profiler.rules.RuleCriterion
and a value. | | void | add(String name, boolean isControl, boolean isNavigation, String value)
Add a property based on a Simple name and value. | | void | add(String name, String value)
Add a property based on a Simple name and value assumed
to be control property. | | void | createFromLocatorPath(String path)
Profiles can be created from a normalized Profile Locator Path
The format of the path is name:value pairs of all property, separated by a path separator. | | String | getLocatorPath()
Profiles can be converted to a normalized Profile Locator Path
The format of the path is name/value pairs of all property, separated by a path separator. | | String | getLocatorPath(ProfileLocatorProperty[] properties)
Normalize profile properties obtained from profile locator iterators
into a Profile Locator Path.
Parameters:
properties - The array of profile properties. | | String | getRequestPath()
| | String | getValue(String name)
| | void | init(Profiler profiler, String requestPath)
Initialize this page context. | | boolean | isControl(String name)
For a given property name, return control status of property. | | boolean | isNavigation(String name)
For a given property name, return navigation status of property. | | Iterator | iterator()
Get an iterator over the locator's properties.
Elements are returned as @link ProfileLocatorProperty array. | | String | toString()
Returns a normalized path. |
| PATH_SEPARATOR | | final public static String PATH_SEPARATOR(Code) | | |
| SECURITY_LOCATOR | | final public static String SECURITY_LOCATOR(Code) | | |
| add | | void add(RuleCriterion criterion, boolean isControl, boolean isNavigation, String value)(Code) | | Add a property based on a @link org.apache.jetspeed.profiler.rules.RuleCriterion
and a value. Rule criteria are templates for locating profile properties.
The value is combined with the rule to create a property.
Parameters:
criterion - The rule criterion on which this property is based.
Parameters:
isControl - The control classification for property.
Parameters:
isNavigation - The navigation classification for property.
Parameters:
value - The value to set on the property. |
| add | | void add(String name, boolean isControl, boolean isNavigation, String value)(Code) | | Add a property based on a Simple name and value.
Parameters:
name - The name of the property.
Parameters:
isControl - The control classification for property.
Parameters:
isNavigation - The control classification for property.
Parameters:
value - The value to set on the property. |
| add | | void add(String name, String value)(Code) | | Add a property based on a Simple name and value assumed
to be control property.
Parameters:
name - The name of the property.
Parameters:
value - The value to set on the property. |
| createFromLocatorPath | | void createFromLocatorPath(String path)(Code) | | Profiles can be created from a normalized Profile Locator Path
The format of the path is name:value pairs of all property, separated by a path separator.
Note: all locator property elements are assumed to be control properties.
An example locator path:
:page:default.psml:artist:air:song:all-i-need
Parameters:
path - The normalized path as shown above from which the locator is created. |
| getLocatorPath | | String getLocatorPath()(Code) | | Profiles can be converted to a normalized Profile Locator Path
The format of the path is name/value pairs of all property, separated by a path separator.
An example locator path:
:page:default.psml:artist:joni-mitchell:song:cary
The normalized path as shown above. |
| getLocatorPath | | String getLocatorPath(ProfileLocatorProperty[] properties)(Code) | | Normalize profile properties obtained from profile locator iterators
into a Profile Locator Path.
Parameters:
properties - The array of profile properties. The normalized path for properties. |
| getRequestPath | | String getRequestPath()(Code) | | Locators are intended to be sufficient to locate managed pages, so the request
path must be generally available in the event it is not otherwise captured in a
rule criterion.
The request path. |
| getValue | | String getValue(String name)(Code) | | For a given property name, get a property of type @link ProfileLocatorProperty
Parameters:
name - The name of the property a property of type @link ProfileLocatorProperty |
| init | | void init(Profiler profiler, String requestPath)(Code) | | Initialize this page context.
Parameters:
profiler - The profiler initializing this locator.
Parameters:
requestPath - The request path used to create this locator. |
| isControl | | boolean isControl(String name)(Code) | | For a given property name, return control status of property.
Parameters:
name - The name of the property control classification flag |
| isNavigation | | boolean isNavigation(String name)(Code) | | For a given property name, return navigation status of property.
Parameters:
name - The name of the property navigation classification flag |
| iterator | | Iterator iterator()(Code) | | Get an iterator over the locator's properties.
Elements are returned as @link ProfileLocatorProperty array.
an iterator over the profile locator properties |
| toString | | String toString()(Code) | | Returns a normalized path. @see #getLocatorPath()
The normalized path representation of this locator. |
|
|