org.apache.sling.hapi.impl

Class MicrodataAttributeHelperImpl

java.lang.Object

org.apache.sling.hapi.impl.MicrodataAttributeHelperImpl

All Implemented Interfaces:

MicrodataAttributeHelper

public class MicrodataAttributeHelperImpl
extends Object
implements MicrodataAttributeHelper

Helper class for HTML microdata attributes

Constructor Summary

Constructors

Constructor and Description
MicrodataAttributeHelperImpl(org.apache.sling.api.resource.ResourceResolver resolver, HApiType type) Get a new microdata html attributes helper for the given HApiType object.

Method Summary

Modifier and Type	Method and Description
Map<String,Map<String,String>>	allItemPropMap() Get a map of maps with the HTMl attributes for each property of the type defined through a new MicrodataAttributeHelper
Map<String,String>	allPropTypesMap() Get a map of types for each type property.
String	itemprop(String propName) Calls MicrodataAttributeHelper.itemprop(String, boolean) with 'withType' true
String	itemprop(String propName, boolean withType) Calls MicrodataAttributeHelper.itempropMap(String, boolean) and normalizes the map into a String of the form 'attr1="val1" attr2="val2"'
Map<String,String>	itempropMap(String propName, boolean withType) Get a map with the HTMl attributes for the given property of the type defined through a new MicrodataAttributeHelper
String	itemtype() Calls MicrodataAttributeHelper.itemtypeMap() and normalizes the map into a String of the form 'attr1="val1" attr2="val2"'
Map<String,String>	itemtypeMap() Get a map with the HTMl attributes for a new item of the type defined through a new MicrodataAttributeHelper object

Methods inherited from class java.lang.Object

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

Constructor Detail

MicrodataAttributeHelperImpl

public MicrodataAttributeHelperImpl(org.apache.sling.api.resource.ResourceResolver resolver,
                                    HApiType type)

Get a new microdata html attributes helper for the given HApiType object.

Provides convenience methods to get the html attributes needed for instrumenting the markup with a Hypermedia API

Parameters:

resolver -

type -

Method Detail

itemtype

public String itemtype()

Calls MicrodataAttributeHelper.itemtypeMap() and normalizes the map into a String of the form 'attr1="val1" attr2="val2"'

Specified by:

itemtype in interface MicrodataAttributeHelper

Returns:

itemtypeMap

public Map<String,String> itemtypeMap()

Get a map with the HTMl attributes for a new item of the type defined through a new MicrodataAttributeHelper object

The key is the HTMl attribute name and the value is the HTML attribute value

Specified by:

itemtypeMap in interface MicrodataAttributeHelper

Returns:

itemprop

public String itemprop(String propName)

Calls MicrodataAttributeHelper.itemprop(String, boolean) with 'withType' true

Specified by:

itemprop in interface MicrodataAttributeHelper

Returns:

itemprop

public String itemprop(String propName,
                       boolean withType)

Calls MicrodataAttributeHelper.itempropMap(String, boolean) and normalizes the map into a String of the form 'attr1="val1" attr2="val2"'

Specified by:

itemprop in interface MicrodataAttributeHelper

Returns:

itempropMap

public Map<String,String> itempropMap(String propName,
                                      boolean withType)

Get a map with the HTMl attributes for the given property of the type defined through a new MicrodataAttributeHelper

The key is the HTMl attribute name and the value is the HTML attribute value

Will through a HApiException runtime exception if the property propName does not exist for the type

Specified by:

itempropMap in interface MicrodataAttributeHelper

Parameters:

propName - the name of the property

withType - whether to include the 'itemtype' attribute

Returns:

allItemPropMap

public Map<String,Map<String,String>> allItemPropMap()

Get a map of maps with the HTMl attributes for each property of the type defined through a new MicrodataAttributeHelper

The key is the property name and the value is a map of attributes like the one returned by MicrodataAttributeHelper.itempropMap(String, boolean)

Specified by:

allItemPropMap in interface MicrodataAttributeHelper

Returns:

allPropTypesMap

public Map<String,String> allPropTypesMap()

Get a map of types for each type property.

The key is the property name and the value is the type path identifier of that property

Specified by:

allPropTypesMap in interface MicrodataAttributeHelper

Returns: