Package org.craftercms.engine.model

Class DefaultSiteItem

java.lang.Object

org.craftercms.engine.model.AbstractXmlSiteItem

org.craftercms.engine.model.DefaultSiteItem

All Implemented Interfaces:

SiteItem

public class DefaultSiteItem
extends AbstractXmlSiteItem

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	Description
protected List<SiteItem>	childItems
protected org.craftercms.core.service.Item	item
protected Comparator<SiteItem>	sortComparator

Fields inherited from class org.craftercms.engine.model.AbstractXmlSiteItem

modelFieldConverter

Constructor Summary

Constructors

Constructor	Description
DefaultSiteItem(org.craftercms.core.service.Item item, org.craftercms.commons.converters.Converter<org.dom4j.Element,Object> modelFieldConverter, Comparator<SiteItem> sortComparator)

Method Summary

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

Methods inherited from class org.craftercms.engine.model.AbstractXmlSiteItem

get, queryValue, queryValue, queryValues, queryValues

Methods inherited from class java.lang.Object

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

Field Details

item

protected org.craftercms.core.service.Item item

childItems

protected List<SiteItem> childItems

sortComparator

protected Comparator<SiteItem> sortComparator

Constructor Details

DefaultSiteItem

public DefaultSiteItem(org.craftercms.core.service.Item item,
 org.craftercms.commons.converters.Converter<org.dom4j.Element,Object> modelFieldConverter,
 Comparator<SiteItem> sortComparator)

Method Details

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()

getRootElement

protected org.dom4j.Element getRootElement()

Specified by:

getRootElement in class AbstractXmlSiteItem

getChildItems

public List<SiteItem> getChildItems()

getChildItem

public SiteItem getChildItem(String storeName)

toString

public String toString()

Overrides:

toString in class Object

sortItems

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

createItemWrapper

public SiteItem createItemWrapper(org.craftercms.core.service.Item item)