com.icfolson.aem.library.core.components

Class AbstractComponent

java.lang.Object

com.icfolson.aem.library.core.components.AbstractComponent

All Implemented Interfaces:

Accessible, ImageSource, Inheritable, Linkable, BasicNode, ComponentNode, Traversable<ComponentNode>

public abstract class AbstractComponent
extends Object
implements ComponentNode

Base class for AEM component classes.

Constructor Summary

Constructors

Constructor and Description
AbstractComponent()

Method Summary

Modifier and Type	Method and Description
org.apache.sling.api.resource.ValueMap	asMap()
com.google.common.base.Optional<ComponentNode>	findAncestor(com.google.common.base.Predicate<ComponentNode> predicate) Find the first ancestor resource that matches the given predicate condition.
com.google.common.base.Optional<ComponentNode>	findAncestor(com.google.common.base.Predicate<ComponentNode> predicate, boolean excludeCurrentResource) Find the first ancestor resource that matches the given predicate condition.
com.google.common.base.Optional<ComponentNode>	findAncestorWithProperty(String propertyName) Find the first ancestor resource containing the given property name.
com.google.common.base.Optional<ComponentNode>	findAncestorWithProperty(String propertyName, boolean excludeCurrentResource) Find the first ancestor resource containing the given property name.
<V> com.google.common.base.Optional<ComponentNode>	findAncestorWithPropertyValue(String propertyName, V propertyValue) Find the first ancestor resource where the given property name has the specified value.
<V> com.google.common.base.Optional<ComponentNode>	findAncestorWithPropertyValue(String propertyName, V propertyValue, boolean excludeCurrentResource) Find the first ancestor resource where the given property name has the specified value.
List<ComponentNode>	findDescendants(com.google.common.base.Predicate<ComponentNode> predicate) Get a list of descendant resources that match the given predicate condition.
<T> com.google.common.base.Optional<T>	get(String propertyName, Class<T> type) Get a property value from the current node.
<T> T	get(String propertyName, T defaultValue) Get a property value from the current node, returning the default value if the property does not exist.
com.google.common.base.Optional<String>	getAsHref(String propertyName) Given a property on this resource containing the path of another resource, get an Optional containing the href to the resource (i.e.
com.google.common.base.Optional<String>	getAsHref(String propertyName, boolean strict) Given a property on this resource containing the path of another resource, get an Optional containing the href to the resource.
com.google.common.base.Optional<String>	getAsHref(String propertyName, boolean strict, boolean mapped) Given a property on this resource containing the path of another resource, get an Optional containing the href to the resource.
com.google.common.base.Optional<String>	getAsHrefInherited(String propertyName) Given a property on this node containing the path of another resource, get the href to the resource, using inheritance if the value does not exist on this component.
com.google.common.base.Optional<String>	getAsHrefInherited(String propertyName, boolean strict) Given a property on this node containing the path of another resource, get the href to the resource, using inheritance if the value does not exist on this component.
com.google.common.base.Optional<String>	getAsHrefInherited(String propertyName, boolean strict, boolean mapped) Given a property on this node containing the path of another resource, get the href to the resource, using inheritance if the value does not exist on this component.
com.google.common.base.Optional<Link>	getAsLink(String propertyName) Given a property on this resource containing the path of another resource, get a link to the resource.
com.google.common.base.Optional<Link>	getAsLink(String propertyName, boolean strict) Given a property on this resource containing the path of another resource, get a link to the resource.
com.google.common.base.Optional<Link>	getAsLink(String propertyName, boolean strict, boolean mapped) Given a property on this resource containing the path of another resource, get a link to the resource.
com.google.common.base.Optional<Link>	getAsLinkInherited(String propertyName) Given a property on this node containing the path of another resource, get a link to the resource, using inheritance if the value does not exist on this component.
com.google.common.base.Optional<Link>	getAsLinkInherited(String propertyName, boolean strict) Given a property on this node containing the path of another resource, get a link to the resource, using inheritance if the value does not exist on this component.
com.google.common.base.Optional<Link>	getAsLinkInherited(String propertyName, boolean strict, boolean mapped) Given a property on this node containing the path of another resource, get a link to the resource, using inheritance if the value does not exist on this component.
<T> List<T>	getAsList(String propertyName, Class<T> type) Get a multi-valued property from the current node as a list of the given type.
<T> List<T>	getAsListInherited(String propertyName, Class<T> type) Get a multi-valued property from the current node as a list of the given type, using inheritance if the value does not exist on this component.
com.google.common.base.Optional<PageDecorator>	getAsPage(String propertyName) Get a page instance from the value of the given property.
com.google.common.base.Optional<PageDecorator>	getAsPageInherited(String propertyName) Get a page from the value of the given property, using inheritance if the value does not exist on this component.
<AdapterType> com.google.common.base.Optional<AdapterType>	getAsType(String propertyName, Class<AdapterType> type) Get an Optional type instance for a property on this resource containing the path of another Resource in the repository.
<AdapterType> com.google.common.base.Optional<AdapterType>	getAsTypeInherited(String propertyName, Class<AdapterType> type) Get an Optional type instance for a property on this resource containing the path of another Resource in the repository, using inheritance if the value does not exist on this component..
com.google.common.base.Optional<ComponentNode>	getComponentNode(String relativePath) Get the component node for the resource at the given path relative to the current node.
com.google.common.base.Optional<ComponentNode>	getComponentNodeInherited(String relativePath) Get a child node relative to the current node, inheriting from a parent page if it does not exist.
List<ComponentNode>	getComponentNodes() Get a list of child nodes for the current node.
List<ComponentNode>	getComponentNodes(com.google.common.base.Predicate<ComponentNode> predicate) Get a predicate-filtered list of child nodes for the current node.
List<ComponentNode>	getComponentNodes(String relativePath) Get a list of child nodes for the resource at the given path relative to this node.
List<ComponentNode>	getComponentNodes(String relativePath, com.google.common.base.Predicate<ComponentNode> predicate) Get a list of child nodes for the resource at the given path relative to this node, returning only the nodes that meet the predicate criteria.
List<ComponentNode>	getComponentNodes(String relativePath, String resourceType) Get a list of child nodes for the resource at the given path relative to this node, returning only the nodes that have the specified resource type.
List<ComponentNode>	getComponentNodesInherited(String relativePath) Get the children of a node relative to the current node.
com.google.common.base.Optional<BasicNode>	getDesignNode() Get the design node for the current component.
String	getHref() Get the URL for this item.
String	getHref(boolean mapped) Get the mapped URL for this item.
String	getId() Get the unique ID for this resource based on the path.
com.google.common.base.Optional<String>	getImageReference() Get the referenced DAM asset path for the default image (named "image") for this component.
com.google.common.base.Optional<String>	getImageReference(boolean isSelf) Get the referenced DAM asset path for the default image (named "image") for this component.
com.google.common.base.Optional<String>	getImageReference(String name)
com.google.common.base.Optional<String>	getImageReferenceInherited()
com.google.common.base.Optional<String>	getImageReferenceInherited(boolean isSelf)
com.google.common.base.Optional<String>	getImageReferenceInherited(String name)
com.google.common.base.Optional<String>	getImageRendition(String renditionName) Get the DAM asset rendition path for the default image (named "image") for this component.
com.google.common.base.Optional<String>	getImageRendition(String name, String renditionName)
com.google.common.base.Optional<String>	getImageSource() Get the image source for the default image (named "image") for this node.
com.google.common.base.Optional<String>	getImageSource(int width) Get the image source for the default image (named "image") for this node for the given width.
com.google.common.base.Optional<String>	getImageSource(String name) Get the image source for this node for the named image.
com.google.common.base.Optional<String>	getImageSource(String name, int width) Get the image source for this node for the named image and given width.
com.google.common.base.Optional<String>	getImageSourceInherited() Get the image source for the default image (named "image") for this node.
com.google.common.base.Optional<String>	getImageSourceInherited(int width) Get the image source for the default image (named "image") for this node for the given width.
com.google.common.base.Optional<String>	getImageSourceInherited(String name) Get the image source for this node for the named image.
com.google.common.base.Optional<String>	getImageSourceInherited(String name, int width) Get the image source for this node for the named image and given width.
int	getIndex() Get the index of this resource in relation to sibling nodes.
int	getIndex(String resourceType) Get the index of this node in relation to sibling nodes, ignoring resource types that do not match the specified value.
<T> com.google.common.base.Optional<T>	getInherited(String propertyName, Class<T> type) Get a property value from the current node.
<T> T	getInherited(String propertyName, T defaultValue) Get a property value from the current node.
Link	getLink() Get a link for this item.
Link	getLink(boolean mapped) Get a link for this item.
LinkBuilder	getLinkBuilder() Get a link builder for the current resource path.
LinkBuilder	getLinkBuilder(boolean mapped) Get a mapped link builder for the current resource path.
com.google.common.base.Optional<Node>	getNode() Get the JCR node for this instance.
com.google.common.base.Optional<ComponentNode>	getParent() Get the parent of this node.
String	getPath() Shortcut for getting the current resource path.
List<Property>	getProperties(com.google.common.base.Predicate<Property> predicate) Get a list of properties that apply for the given predicate.
org.apache.sling.api.resource.Resource	getResource() Get the underlying resource for this instance.
boolean	isHasImage() Check if the current resource has a default image.
boolean	isHasImage(String name) Check if the current resource has a named image.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractComponent

public AbstractComponent()

Method Detail

getHref

public String getHref()

Description copied from interface: Linkable

Get the URL for this item.

Specified by:

getHref in interface Linkable

Returns:

href

getImageSource

public com.google.common.base.Optional<String> getImageSource()

Description copied from interface: ImageSource

Get the image source for the default image (named "image") for this node. Uses the image servlet rather than a direct reference to the DAM path.

Specified by:

getImageSource in interface ImageSource

Returns:

optional image source (absent if the referenced image has no content)

asMap

public org.apache.sling.api.resource.ValueMap asMap()

Specified by:

asMap in interface Accessible

Returns:

map of property names to values, or empty map if underlying resource is null or nonexistent

getHref

public String getHref(boolean mapped)

Description copied from interface: Linkable

Get the mapped URL for this item.

Specified by:

getHref in interface Linkable

Parameters:

mapped - if true, the path will be routed through the resource resolver to determine the mapped path (e.g. without leading "/content").

Returns:

mapped href

getAsHrefInherited

public com.google.common.base.Optional<String> getAsHrefInherited(String propertyName)

Description copied from interface: Inheritable

Given a property on this node containing the path of another resource, get the href to the resource, using inheritance if the value does not exist on this component.

Specified by:

getAsHrefInherited in interface Inheritable

Parameters:

propertyName - name of property containing a valid content path

Returns:

Optional href

getLink

public Link getLink()

Description copied from interface: Linkable

Get a link for this item.

Specified by:

getLink in interface Linkable

Returns:

link

getImageSource

public com.google.common.base.Optional<String> getImageSource(int width)

Description copied from interface: ImageSource

Get the image source for the default image (named "image") for this node for the given width.

Specified by:

getImageSource in interface ImageSource

Parameters:

width - image width

Returns:

optional image source (absent if the referenced image has no content)

get

public <T> T get(String propertyName,
                 T defaultValue)

Description copied from interface: Accessible

Get a property value from the current node, returning the default value if the property does not exist.

Specified by:

get in interface Accessible

Type Parameters:

T - property type

Parameters:

propertyName - property name

defaultValue - default value

Returns:

property value or default value if it does not exist

getComponentNode

public com.google.common.base.Optional<ComponentNode> getComponentNode(String relativePath)

Description copied from interface: ComponentNode

Get the component node for the resource at the given path relative to the current node.

Specified by:

getComponentNode in interface ComponentNode

Parameters:

relativePath - relative path to component

Returns:

Optional node for component

getLink

public Link getLink(boolean mapped)

Description copied from interface: Linkable

Get a link for this item.

Specified by:

getLink in interface Linkable

Parameters:

mapped - if true, the Link path will be routed through the resource resolver to determine the mapped path (e.g. without leading "/content").

Returns:

mapped link

getImageSource

public com.google.common.base.Optional<String> getImageSource(String name)

Description copied from interface: ImageSource

Get the image source for this node for the named image.

Specified by:

getImageSource in interface ImageSource

Parameters:

name - image name (name of image as defined in dialog)

Returns:

optional image source (absent if the referenced image has no content)

getComponentNodes

public List<ComponentNode> getComponentNodes()

Description copied from interface: ComponentNode

Get a list of child nodes for the current node.

Specified by:

getComponentNodes in interface ComponentNode

Returns:

list of component nodes or empty list if none exist

getLinkBuilder

public LinkBuilder getLinkBuilder()

Description copied from interface: Linkable

Get a link builder for the current resource path.

Specified by:

getLinkBuilder in interface Linkable

Returns:

builder instance for this item

getImageSource

public com.google.common.base.Optional<String> getImageSource(String name,
                                                              int width)

Description copied from interface: ImageSource

Get the image source for this node for the named image and given width.

Specified by:

getImageSource in interface ImageSource

Parameters:

name - image name (name of image as defined in dialog)

width - image width

Returns:

optional image source (absent if the referenced image has no content)

get

public <T> com.google.common.base.Optional<T> get(String propertyName,
                                                  Class<T> type)

Description copied from interface: Accessible

Get a property value from the current node. This returns the same value as the underlying ValueMap wrapped in an Optional instance instead of returning null.

Specified by:

get in interface Accessible

Type Parameters:

T - property type

Parameters:

propertyName - property name

type - property type

Returns:

Optional of the given type containing the property value or absent if the property does not exist

getId

public String getId()

Description copied from interface: BasicNode

Get the unique ID for this resource based on the path. If this node is the descendant of a page, the page path will be removed from the identifier, since the relative path of a component node is always unique for a page.

Specified by:

getId in interface BasicNode

Returns:

unique ID

getAsHrefInherited

public com.google.common.base.Optional<String> getAsHrefInherited(String propertyName,
                                                                  boolean strict)

Description copied from interface: Inheritable

Given a property on this node containing the path of another resource, get the href to the resource, using inheritance if the value does not exist on this component. Use this method with a true argument when appending ".html" to the resource path is desired only for valid CQ pages and not external paths.

Specified by:

getAsHrefInherited in interface Inheritable

Parameters:

propertyName - name of property containing a valid content path

strict - if true, strict resource resolution will be applied and only valid CQ content paths will have ".html" appended

Returns:

Optional href

getComponentNodes

public List<ComponentNode> getComponentNodes(com.google.common.base.Predicate<ComponentNode> predicate)

Description copied from interface: ComponentNode

Get a predicate-filtered list of child nodes for the current node.

Specified by:

getComponentNodes in interface ComponentNode

Parameters:

predicate - predicate used to filter nodes

Returns:

list of component nodes that meet the predicate criteria or empty list if none exist

isHasImage

public boolean isHasImage()

Description copied from interface: ImageSource

Check if the current resource has a default image.

Specified by:

isHasImage in interface ImageSource

Returns:

true if image has content

getLinkBuilder

public LinkBuilder getLinkBuilder(boolean mapped)

Description copied from interface: Linkable

Get a mapped link builder for the current resource path.

Specified by:

getLinkBuilder in interface Linkable

Parameters:

mapped - if true, the LinkBuilder for this resource will be routed through the resource resolver to determine the mapped path (e.g. without leading "/content").

Returns:

builder instance for this item containing the mapped link

getIndex

public int getIndex()

Description copied from interface: BasicNode

Get the index of this resource in relation to sibling nodes.

Specified by:

getIndex in interface BasicNode

Returns:

index in sibling nodes or -1 if resource is null or has null parent node

isHasImage

public boolean isHasImage(String name)

Description copied from interface: ImageSource

Check if the current resource has a named image.

Specified by:

isHasImage in interface ImageSource

Parameters:

name - image name (name of image as defined in dialog)

Returns:

true if image has content

getComponentNodes

public List<ComponentNode> getComponentNodes(String relativePath)

Description copied from interface: ComponentNode

Get a list of child nodes for the resource at the given path relative to this node.

Specified by:

getComponentNodes in interface ComponentNode

Parameters:

relativePath - relative path to parent of desired nodes

Returns:

list of component nodes below the specified relative path or empty list if none exist

getAsHref

public com.google.common.base.Optional<String> getAsHref(String propertyName)

Description copied from interface: Accessible

Given a property on this resource containing the path of another resource, get an Optional containing the href to the resource (i.e. the content path with ".html" appended).

Specified by:

getAsHref in interface Accessible

Parameters:

propertyName - name of property containing a valid content path

Returns:

href value wrapped in an Optional

getIndex

public int getIndex(String resourceType)

Description copied from interface: BasicNode

Get the index of this node in relation to sibling nodes, ignoring resource types that do not match the specified value.

Specified by:

getIndex in interface BasicNode

Parameters:

resourceType - sling:resourceType to filter on

Returns:

index in sibling nodes or -1 if resource is null or has null parent node

getNode

public com.google.common.base.Optional<Node> getNode()

Description copied from interface: BasicNode

Get the JCR node for this instance. This will return an absent Optional if the underlying resource for this instance is synthetic or non-existent.

Specified by:

getNode in interface BasicNode

Returns:

Optional node for this resource

getComponentNodes

public List<ComponentNode> getComponentNodes(String relativePath,
                                             String resourceType)

Description copied from interface: ComponentNode

Get a list of child nodes for the resource at the given path relative to this node, returning only the nodes that have the specified resource type.

Specified by:

getComponentNodes in interface ComponentNode

Parameters:

relativePath - relative path to parent of desired nodes

resourceType - sling:resourceType of nodes to get from parent node

Returns:

list of component nodes matching the given resource type below the specified relative path or empty list if none exist

getPath

public String getPath()

Description copied from interface: BasicNode

Shortcut for getting the current resource path.

Specified by:

getPath in interface BasicNode

Returns:

resource path

getAsHref

public com.google.common.base.Optional<String> getAsHref(String propertyName,
                                                         boolean strict)

Description copied from interface: Accessible

Given a property on this resource containing the path of another resource, get an Optional containing the href to the resource. Use this method with a true argument when appending ".html" to the resource path is desired only for valid CQ pages and not external paths.

Specified by:

getAsHref in interface Accessible

Parameters:

propertyName - name of property containing a valid content path

strict - if true, strict resource resolution will be applied and only valid CQ content paths will have ".html" appended

Returns:

href value wrapped in an Optional

getAsHrefInherited

public com.google.common.base.Optional<String> getAsHrefInherited(String propertyName,
                                                                  boolean strict,
                                                                  boolean mapped)

Description copied from interface: Inheritable

Given a property on this node containing the path of another resource, get the href to the resource, using inheritance if the value does not exist on this component. Use this method with a true argument when appending ".html" to the resource path is desired only for valid CQ pages and not external paths. Setting mapped to true will map the path value, if it exists, through the Sling Resource Resolver.

Specified by:

getAsHrefInherited in interface Inheritable

Parameters:

propertyName - name of property containing a valid content path

strict - if true, strict resource resolution will be applied and only valid CQ content paths will have ".html" appended

mapped - if true, the property value will be routed through the Resource Resolver to determine the mapped path for the value. For example, if a mapping from "/content/" to "/" exists in the Apache Sling Resource Resolver Factory OSGi configuration, getting the mapped href for the path "/content/citytechinc" will return "/citytechinc.html".

Returns:

Optional href

getProperties

public List<Property> getProperties(com.google.common.base.Predicate<Property> predicate)
                             throws RepositoryException

Description copied from interface: BasicNode

Get a list of properties that apply for the given predicate.

Specified by:

getProperties in interface BasicNode

Parameters:

predicate - predicate to apply

Returns:

filtered list of properties or empty list if no properties of this node apply for the given predicate

Throws:

RepositoryException - if error occurs reading node properties

getComponentNodes

public List<ComponentNode> getComponentNodes(String relativePath,
                                             com.google.common.base.Predicate<ComponentNode> predicate)

Description copied from interface: ComponentNode

Get a list of child nodes for the resource at the given path relative to this node, returning only the nodes that meet the predicate criteria.

Specified by:

getComponentNodes in interface ComponentNode

Parameters:

relativePath - relative path to parent of desired nodes

predicate - predicate used to filter nodes

Returns:

list of component nodes that meet the predicate criteria below the specified relative path or empty list if none exist

getResource

public org.apache.sling.api.resource.Resource getResource()

Description copied from interface: BasicNode

Get the underlying resource for this instance.

Specified by:

getResource in interface BasicNode

Returns:

current resource

getDesignNode

public com.google.common.base.Optional<BasicNode> getDesignNode()

Description copied from interface: ComponentNode

Get the design node for the current component.

Specified by:

getDesignNode in interface ComponentNode

Returns:

Optional design node for the current style

getAsLinkInherited

public com.google.common.base.Optional<Link> getAsLinkInherited(String propertyName)

Description copied from interface: Inheritable

Given a property on this node containing the path of another resource, get a link to the resource, using inheritance if the value does not exist on this component.

Specified by:

getAsLinkInherited in interface Inheritable

Parameters:

propertyName - name of property containing a valid content path

Returns:

Optional link object, or null if the property does not contain a valid content path

getComponentNodeInherited

public com.google.common.base.Optional<ComponentNode> getComponentNodeInherited(String relativePath)

Description copied from interface: ComponentNode

Get a child node relative to the current node, inheriting from a parent page if it does not exist.

Specified by:

getComponentNodeInherited in interface ComponentNode

Parameters:

relativePath - path relative to current node

Returns:

direct child node if it exists, otherwise the child node at this relative path for an ancestor page

getAsHref

public com.google.common.base.Optional<String> getAsHref(String propertyName,
                                                         boolean strict,
                                                         boolean mapped)

Description copied from interface: Accessible

Given a property on this resource containing the path of another resource, get an Optional containing the href to the resource. Use this method with a true argument when appending ".html" to the resource path is desired only for valid CQ pages and not external paths. Setting mapped to true will map the path value, if it exists, through the Sling Resource Resolver.

Specified by:

getAsHref in interface Accessible

Parameters:

propertyName - name of property containing a valid content path

strict - if true, strict resource resolution will be applied and only valid CQ content paths will have ".html" appended

mapped - if true, the property value will be routed through the Resource Resolver to determine the mapped path for the value. For example, if a mapping from "/content/" to "/" exists in the Apache Sling Resource Resolver Factory OSGi configuration, getting the mapped href for the path "/content/citytechinc" will return "/citytechinc.html".

Returns:

href value wrapped in an Optional

getAsLinkInherited

public com.google.common.base.Optional<Link> getAsLinkInherited(String propertyName,
                                                                boolean strict)

Description copied from interface: Inheritable

Given a property on this node containing the path of another resource, get a link to the resource, using inheritance if the value does not exist on this component. Use this method with a true argument when including an extension for the link is desired only for valid CQ pages and not external paths.

Specified by:

getAsLinkInherited in interface Inheritable

Parameters:

propertyName - name of property containing a valid content path

strict - if true, strict resource resolution will be applied and only valid CQ content paths will have an extension

Returns:

Optional link object, or null if the property does not contain a valid content path

getComponentNodesInherited

public List<ComponentNode> getComponentNodesInherited(String relativePath)

Description copied from interface: ComponentNode

Get the children of a node relative to the current node. If node does not exist relative to current page, inherit from a parent page.

Specified by:

getComponentNodesInherited in interface ComponentNode

Parameters:

relativePath - path relative to current node

Returns:

list of nodes representing children of the addressed node or inherited from a parent page (or empty list if none exist)

getParent

public com.google.common.base.Optional<ComponentNode> getParent()

Description copied from interface: ComponentNode

Get the parent of this node.

Specified by:

getParent in interface ComponentNode

Returns:

parent component node or absent optional if resource has no parent

getAsLink

public com.google.common.base.Optional<Link> getAsLink(String propertyName)

Description copied from interface: Accessible

Given a property on this resource containing the path of another resource, get a link to the resource.

Specified by:

getAsLink in interface Accessible

Parameters:

propertyName - name of property containing a valid content path

Returns:

Optional link object, absent if property does not contain a valid content path

getAsLink

public com.google.common.base.Optional<Link> getAsLink(String propertyName,
                                                       boolean strict)

Description copied from interface: Accessible

Given a property on this resource containing the path of another resource, get a link to the resource. Use this method with a true argument when including an extension for the link is desired only for valid CQ pages and not external paths.

Specified by:

getAsLink in interface Accessible

Parameters:

propertyName - name of property containing a valid content path

strict - if true, strict resource resolution will be applied and only valid CQ content paths will have an extension

Returns:

Optional link object, absent if property does not contain a valid content path

getAsLinkInherited

public com.google.common.base.Optional<Link> getAsLinkInherited(String propertyName,
                                                                boolean strict,
                                                                boolean mapped)

Description copied from interface: Inheritable

Given a property on this node containing the path of another resource, get a link to the resource, using inheritance if the value does not exist on this component. Use this method with a true argument when including an extension for the link is desired only for valid CQ pages and not external paths. Setting mapped to true will map the path value, if it exists, through the Sling Resource Resolver.

Specified by:

getAsLinkInherited in interface Inheritable

Parameters:

propertyName - name of property containing a valid content path

strict - if true, strict resource resolution will be applied and only valid CQ content paths will have an extension

mapped - if true, the property value will be routed through the Resource Resolver to determine the mapped path for the value. For example, if a mapping from "/content/" to "/" exists in the Apache Sling Resource Resolver Factory OSGi configuration, the Link path will be "/citytechinc" rather than "/content/citytechinc".

Returns:

Optional link object, or null if the property does not contain a valid content path

getAsListInherited

public <T> List<T> getAsListInherited(String propertyName,
                                      Class<T> type)

Description copied from interface: Inheritable

Get a multi-valued property from the current node as a list of the given type, using inheritance if the value does not exist on this component.

Specified by:

getAsListInherited in interface Inheritable

Type Parameters:

T - property type

Parameters:

propertyName - name of multi-valued property

type - property type

Returns:

list of property values or an empty list if the property does not exist

getAsLink

public com.google.common.base.Optional<Link> getAsLink(String propertyName,
                                                       boolean strict,
                                                       boolean mapped)

Description copied from interface: Accessible

Given a property on this resource containing the path of another resource, get a link to the resource. Use this method with a true argument when including an extension for the link is desired only for valid CQ pages and not external paths. Setting mapped to true will map the path value, if it exists, through the Sling Resource Resolver.

Specified by:

getAsLink in interface Accessible

Parameters:

propertyName - name of property containing a valid content path

strict - if true, strict resource resolution will be applied and only valid CQ content paths will have an extension

mapped - if true, the property value will be routed through the Resource Resolver to determine the mapped path for the value. For example, if a mapping from "/content/" to "/" exists in the Apache Sling Resource Resolver Factory OSGi configuration, the Link path will be "/citytechinc" rather than "/content/citytechinc".

Returns:

Optional link object, absent if property does not contain a valid content path

getAsPageInherited

public com.google.common.base.Optional<PageDecorator> getAsPageInherited(String propertyName)

Description copied from interface: Inheritable

Get a page from the value of the given property, using inheritance if the value does not exist on this component. The property value will be localized to the current page context before getting the page.

Specified by:

getAsPageInherited in interface Inheritable

Parameters:

propertyName - property name

Returns:

Optional page for property value

getAsList

public <T> List<T> getAsList(String propertyName,
                             Class<T> type)

Description copied from interface: Accessible

Get a multi-valued property from the current node as a list of the given type.

Specified by:

getAsList in interface Accessible

Type Parameters:

T - property type, must be supported by ValueMap

Parameters:

propertyName - name of multi-valued property

type - property type

Returns:

list of property values or an empty list if the property does not exist

getAsTypeInherited

public <AdapterType> com.google.common.base.Optional<AdapterType> getAsTypeInherited(String propertyName,
                                                                                     Class<AdapterType> type)

Description copied from interface: Inheritable

Get an Optional type instance for a property on this resource containing the path of another Resource in the repository, using inheritance if the value does not exist on this component..

Specified by:

getAsTypeInherited in interface Inheritable

Type Parameters:

AdapterType - adapter class that is adaptable from Resource

Parameters:

propertyName - name of property containing a resource path

type - type to adapt from resource

Returns:

Optional instance of the specified type, or absent if either the property does not exist or the resource does not adapt to the provided type

getImageReferenceInherited

public com.google.common.base.Optional<String> getImageReferenceInherited(boolean isSelf)

Specified by:

getImageReferenceInherited in interface Inheritable

Returns:

Optional inherited image reference

getAsPage

public com.google.common.base.Optional<PageDecorator> getAsPage(String propertyName)

Description copied from interface: Accessible

Get a page instance from the value of the given property. Will return an absent Optional if the path value for the given property name does not resolve to a valid CQ page.

Specified by:

getAsPage in interface Accessible

Parameters:

propertyName - property name

Returns:

Optional page for property value

getImageReferenceInherited

public com.google.common.base.Optional<String> getImageReferenceInherited()

Specified by:

getImageReferenceInherited in interface Inheritable

Returns:

Optional inherited image reference

getImageReferenceInherited

public com.google.common.base.Optional<String> getImageReferenceInherited(String name)

Specified by:

getImageReferenceInherited in interface Inheritable

Parameters:

name - image name

Returns:

Optional inherited image reference

getImageSourceInherited

public com.google.common.base.Optional<String> getImageSourceInherited()

Description copied from interface: Inheritable

Get the image source for the default image (named "image") for this node. Uses the image servlet rather than a direct reference to the DAM path.

Specified by:

getImageSourceInherited in interface Inheritable

Returns:

optional inherited image source

getAsType

public <AdapterType> com.google.common.base.Optional<AdapterType> getAsType(String propertyName,
                                                                            Class<AdapterType> type)

Description copied from interface: Accessible

Get an Optional type instance for a property on this resource containing the path of another Resource in the repository.

Specified by:

getAsType in interface Accessible

Type Parameters:

AdapterType - adapter class that is adaptable from Resource

Parameters:

propertyName - name of property containing a resource path

type - type to adapt from resource

Returns:

Optional instance of the specified type, or absent if either the property does not exist or the resource does not adapt to the provided type

getImageReference

public com.google.common.base.Optional<String> getImageReference(boolean isSelf)

Description copied from interface: Accessible

Get the referenced DAM asset path for the default image (named "image") for this component.

Specified by:

getImageReference in interface Accessible

Parameters:

isSelf - if true, image reference property will be accessed from the current resource rather than a child

Returns:

Optional image reference path

getImageSourceInherited

public com.google.common.base.Optional<String> getImageSourceInherited(int width)

Description copied from interface: Inheritable

Get the image source for the default image (named "image") for this node for the given width.

Specified by:

getImageSourceInherited in interface Inheritable

Parameters:

width - image width

Returns:

optional inherited image source

getImageReference

public com.google.common.base.Optional<String> getImageReference()

Description copied from interface: Accessible

Get the referenced DAM asset path for the default image (named "image") for this component.

Specified by:

getImageReference in interface Accessible

Returns:

Optional image reference path

getImageReference

public com.google.common.base.Optional<String> getImageReference(String name)

Specified by:

getImageReference in interface Accessible

Parameters:

name - image name

Returns:

Optional image reference path

getImageSourceInherited

public com.google.common.base.Optional<String> getImageSourceInherited(String name)

Description copied from interface: Inheritable

Get the image source for this node for the named image.

Specified by:

getImageSourceInherited in interface Inheritable

Parameters:

name - image name (name of image as defined in dialog)

Returns:

optional inherited image source

getImageRendition

public com.google.common.base.Optional<String> getImageRendition(String renditionName)

Description copied from interface: Accessible

Get the DAM asset rendition path for the default image (named "image") for this component.

Specified by:

getImageRendition in interface Accessible

Parameters:

renditionName - rendition name for this asset (e.g. "cq5dam.thumbnail.140.100.png")

Returns:

Optional image rendition path

getImageSourceInherited

public com.google.common.base.Optional<String> getImageSourceInherited(String name,
                                                                       int width)

Description copied from interface: Inheritable

Get the image source for this node for the named image and given width.

Specified by:

getImageSourceInherited in interface Inheritable

Parameters:

name - image name (name of image as defined in dialog)

width - image width

Returns:

optional inherited image source

getImageRendition

public com.google.common.base.Optional<String> getImageRendition(String name,
                                                                 String renditionName)

Specified by:

getImageRendition in interface Accessible

Parameters:

name - image name

renditionName - rendition name for this asset

Returns:

Optional image rendition path

getInherited

public <T> T getInherited(String propertyName,
                          T defaultValue)

Description copied from interface: Inheritable

Get a property value from the current node. If no value is found, recurse up the content tree respective to the page and relative node path until a value is found.

Specified by:

getInherited in interface Inheritable

Type Parameters:

T - result type

Parameters:

propertyName - property to get

defaultValue - value if no result is found

Returns:

inherited value

getInherited

public <T> com.google.common.base.Optional<T> getInherited(String propertyName,
                                                           Class<T> type)

Description copied from interface: Inheritable

Get a property value from the current node. If no value is found, recurse up the content tree respective to the page and relative node path until a value is found, returning an absent Optional if not. This returns the same value as the underlying ValueMap wrapped in an Optional instance instead of returning null.

Specified by:

getInherited in interface Inheritable

Type Parameters:

T - type

Parameters:

propertyName - property name

type - property type

Returns:

Optional of the given type containing the property value or absent if no value is found

findAncestor

public com.google.common.base.Optional<ComponentNode> findAncestor(com.google.common.base.Predicate<ComponentNode> predicate)

Description copied from interface: Traversable

Find the first ancestor resource that matches the given predicate condition.

Specified by:

findAncestor in interface Traversable<ComponentNode>

Parameters:

predicate - predicate to match ancestor resources against

Returns:

Optional resource that matches the predicate condition

findAncestor

public com.google.common.base.Optional<ComponentNode> findAncestor(com.google.common.base.Predicate<ComponentNode> predicate,
                                                                   boolean excludeCurrentResource)

Description copied from interface: Traversable

Find the first ancestor resource that matches the given predicate condition.

Specified by:

findAncestor in interface Traversable<ComponentNode>

Parameters:

predicate - predicate to match ancestor resources against

excludeCurrentResource - if true, the current resource will be excluded (i.e. even if the current resource matches the predicate criteria, it will not be returned)

Returns:

Optional resource that matches the predicate condition

findAncestorWithProperty

public com.google.common.base.Optional<ComponentNode> findAncestorWithProperty(String propertyName)

Description copied from interface: Traversable

Find the first ancestor resource containing the given property name.

Specified by:

findAncestorWithProperty in interface Traversable<ComponentNode>

Parameters:

propertyName - property name to find on ancestor resources

Returns:

Optional resource that contains the property

findAncestorWithProperty

public com.google.common.base.Optional<ComponentNode> findAncestorWithProperty(String propertyName,
                                                                               boolean excludeCurrentResource)

Description copied from interface: Traversable

Find the first ancestor resource containing the given property name.

Specified by:

findAncestorWithProperty in interface Traversable<ComponentNode>

Parameters:

propertyName - property name to find on ancestor resources

excludeCurrentResource - if true, the current resource will be excluded (i.e. even if the current resource matches the predicate criteria, it will not be returned)

Returns:

Optional resource that contains the property

findAncestorWithPropertyValue

public <V> com.google.common.base.Optional<ComponentNode> findAncestorWithPropertyValue(String propertyName,
                                                                                        V propertyValue)

Description copied from interface: Traversable

Find the first ancestor resource where the given property name has the specified value.

Specified by:

findAncestorWithPropertyValue in interface Traversable<ComponentNode>

Type Parameters:

V - type of value

Parameters:

propertyName - property name to find on ancestor resources

propertyValue - value of named property to match

Returns:

Optional resource that contains the property value

findAncestorWithPropertyValue

public <V> com.google.common.base.Optional<ComponentNode> findAncestorWithPropertyValue(String propertyName,
                                                                                        V propertyValue,
                                                                                        boolean excludeCurrentResource)

Description copied from interface: Traversable

Find the first ancestor resource where the given property name has the specified value.

Specified by:

findAncestorWithPropertyValue in interface Traversable<ComponentNode>

Type Parameters:

V - type of value

Parameters:

propertyName - property name to find on ancestor resources

propertyValue - value of named property to match

excludeCurrentResource - if true, the current resource will be excluded (i.e. even if the current resource matches the predicate criteria, it will not be returned)

Returns:

Optional resource that contains the property value

findDescendants

public List<ComponentNode> findDescendants(com.google.common.base.Predicate<ComponentNode> predicate)

Description copied from interface: Traversable

Get a list of descendant resources that match the given predicate condition.

Specified by:

findDescendants in interface Traversable<ComponentNode>

Parameters:

predicate - predicate to match descendant resources against

Returns:

list of resources that match the predicate condition or empty list if none exist