Package org.craftercms.engine.model

Class EmbeddedSiteItem

java.lang.Object

org.craftercms.engine.model.AbstractXmlSiteItem

org.craftercms.engine.model.EmbeddedSiteItem

All Implemented Interfaces:

SiteItem

public class EmbeddedSiteItem
extends AbstractXmlSiteItem

Implementation of SiteItem for embedded site items

Since:

3.1.2

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected String	componentId	The unique id of the embedded component
protected SiteItem	parentItem	The parent of the embedded component
protected org.dom4j.Element	rootElement	The XML root element of the embedded component
static final String	XPATH_OBJECT_ID

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

modelFieldConverter

Constructor Summary

Constructors

Constructor	Description
EmbeddedSiteItem(SiteItem parentItem, org.dom4j.Element rootElement, org.craftercms.commons.converters.Converter<org.dom4j.Element,Object> modelFieldConverter)

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

XPATH_OBJECT_ID

public static final String XPATH_OBJECT_ID

See Also:

• Constant Field Values

parentItem

protected SiteItem parentItem

The parent of the embedded component

componentId

protected String componentId

The unique id of the embedded component

rootElement

protected org.dom4j.Element rootElement

The XML root element of the embedded component

Constructor Details

EmbeddedSiteItem

public EmbeddedSiteItem(SiteItem parentItem,
 org.dom4j.Element rootElement,
 org.craftercms.commons.converters.Converter<org.dom4j.Element,Object> modelFieldConverter)

Method Details

getRootElement

protected org.dom4j.Element getRootElement()

Specified by:

getRootElement in class AbstractXmlSiteItem

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

getChildItems

public List<SiteItem> getChildItems()

getChildItem

public SiteItem getChildItem(String storeName)

sortItems

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

createItemWrapper

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

toString

public String toString()

Overrides:

toString in class Object