org.craftercms.engine.model

Class SiteItem

java.lang.Object

org.craftercms.engine.model.SiteItem

public class SiteItem
extends Object

Basic adapter to a Item, enhanced with methods that can be easily invoked in template engines like Freemarker. The generic get method allows things like ${model.header.title} in Freemarker.

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field and Description
protected List<SiteItem>	childItems
protected org.craftercms.core.service.Item	item
protected Map<String,ModelValueConverter<?>>	modelValueConverters
protected Comparator<SiteItem>	sortComparator

Constructor Summary

Constructors

Constructor and Description
SiteItem(org.craftercms.core.service.Item item, Map<String,ModelValueConverter<?>> modelValueConverters)
SiteItem(org.craftercms.core.service.Item item, Map<String,ModelValueConverter<?>> modelValueConverters, Comparator<SiteItem> sortComparator)

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	convertModelValue(org.dom4j.Element element)
Object	get(String xPathQuery)
SiteItem	getChildItem(String storeName)
List<SiteItem>	getChildItems()
org.dom4j.Document	getDom()
org.craftercms.core.service.Item	getItem()
Map<String,Object>	getProperties()
String	getStoreName()
String	getStoreUrl()
boolean	isFolder()
String	queryValue(String xPathQuery)
String	queryValue(String xPathQuery, Map<String,String> namespaceUris)
List<String>	queryValues(String xPathQuery)
List<String>	queryValues(String xPathQuery, Map<String,String> namespaceUris)
protected List<SiteItem>	sortItems(List<SiteItem> items, Comparator<SiteItem> comparator)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

item

protected org.craftercms.core.service.Item item

childItems

protected List<SiteItem> childItems

modelValueConverters

protected Map<String,ModelValueConverter<?>> modelValueConverters

sortComparator

protected Comparator<SiteItem> sortComparator

Constructor Detail

SiteItem

public SiteItem(org.craftercms.core.service.Item item,
        Map<String,ModelValueConverter<?>> modelValueConverters)

SiteItem

public SiteItem(org.craftercms.core.service.Item item,
        Map<String,ModelValueConverter<?>> modelValueConverters,
        Comparator<SiteItem> sortComparator)

Method Detail

getItem

public org.craftercms.core.service.Item getItem()

getStoreName

public String getStoreName()

getStoreUrl

public String getStoreUrl()

isFolder

public boolean isFolder()

getDom

public org.dom4j.Document getDom()

getProperties

public Map<String,Object> getProperties()

get

public Object get(String xPathQuery)

queryValue

public String queryValue(String xPathQuery)

queryValues

public List<String> queryValues(String xPathQuery)

queryValue

public String queryValue(String xPathQuery,
                Map<String,String> namespaceUris)

queryValues

public List<String> queryValues(String xPathQuery,
                       Map<String,String> namespaceUris)

getChildItems

public List<SiteItem> getChildItems()

getChildItem

public SiteItem getChildItem(String storeName)

toString

public String toString()

Overrides:

toString in class Object

sortItems

protected List<SiteItem> sortItems(List<SiteItem> items,
                       Comparator<SiteItem> comparator)

convertModelValue

protected Object convertModelValue(org.dom4j.Element element)