com.foreach.across.modules.webcms.domain.component.model

Class WebCmsComponentModel

java.lang.Object

com.foreach.across.modules.webcms.domain.component.model.WebCmsComponentModel

All Implemented Interfaces:

com.foreach.across.modules.web.ui.ViewElement, WebCmsDomainBound, WebCmsObject

Direct Known Subclasses:

ContainerWebCmsComponentModel, ImageWebCmsComponentModel, PlaceholderWebCmsComponentModel, ProxyWebCmsComponentModel, TextWebCmsComponentModel

public abstract class WebCmsComponentModel
extends Object
implements com.foreach.across.modules.web.ui.ViewElement, WebCmsObject, WebCmsDomainBound

Represents a base model for strongly typed web component implementations, backed by a WebCmsComponent entity.

Since:

0.0.1

Author:

Arne Vandamme

Nested Class Summary

Nested classes/interfaces inherited from interface com.foreach.across.modules.web.ui.ViewElement

com.foreach.across.modules.web.ui.ViewElement.Wither<T extends com.foreach.across.modules.web.ui.ViewElement>, com.foreach.across.modules.web.ui.ViewElement.WitherGetter<T extends com.foreach.across.modules.web.ui.ViewElement,U>, com.foreach.across.modules.web.ui.ViewElement.WitherRemover<T extends com.foreach.across.modules.web.ui.ViewElement>, com.foreach.across.modules.web.ui.ViewElement.WitherSetter<T extends com.foreach.across.modules.web.ui.ViewElement>

Field Summary

Fields

Modifier and Type	Field and Description
static String	METADATA_CLASS_ATTRIBUTE Common attribute used to specify the fully qualified class name of the metadata for a particular component type.
static String	TEMPLATE_ATTRIBUTE Common attribute used to specify the (Thymeleaf) template that should be used to render components of that type.
static String	TYPE_ATTRIBUTE Common attribute used to specify the base type of the component type.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebCmsComponentModel() Deprecated.
protected	WebCmsComponentModel(WebCmsComponent component)
protected	WebCmsComponentModel(WebCmsComponentModel template) Base constructor for asComponentTemplate() calls, uses the parent component as template and attempts to convert the metadata to a new instance.
protected	WebCmsComponentModel(WebCmsComponentType componentType)

Method Summary

Modifier and Type	Method and Description
abstract WebCmsComponentModel	asComponentTemplate() Convert the current model to a templated version: keep all properties but create a new backing component.
protected static Object	cloneMetadata(WebCmsComponentModel componentModel) Attempt to forcibly clone the metadata of a WebCmsComponentModel.
boolean	equals(Object o)
WebCmsComponentType	getComponentType()
String	getCustomTemplate() Implements ViewElement.getCustomTemplate().
WebCmsDomain	getDomain()
String	getElementType()
<V extends U,U> V	getMetadata(Class<U> metadataType) Coerce the metadata to the type specified.
String	getName()
String	getObjectId()
String	getOwnerObjectId()
int	getSortIndex()
String	getTitle()
int	hashCode()
boolean	hasMetadata()
boolean	hasOwner()
abstract boolean	isEmpty() Base implementation that can be used to check if the component contains any relevant data.
boolean	isNew()
void	setComponent(@NonNull WebCmsComponent component) Set the original component backing this model, can never be null.
void	setDomain(WebCmsDomain domain) Set the WebCmsDomain this entity belongs to.
void	setName(String name) Set the name on the backing component.
void	setObjectId(String objectId) Set the unique object id of the backing component
void	setOwner(WebCmsObject owner) Set the owner object of the backing component.
void	setOwnerObjectId(String ownerObjectId) Set the owner object id of the backing component.
void	setSortIndex(int sortIndex)
void	setTitle(String title) Set the title on the backing component.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.foreach.across.modules.web.ui.ViewElement

get, matches, predicateFor, remove, set, with

Methods inherited from interface com.foreach.across.modules.webcms.domain.WebCmsObject

forObjectId

Field Detail

TYPE_ATTRIBUTE

public static final String TYPE_ATTRIBUTE

Common attribute used to specify the base type of the component type.

See Also:

Constant Field Values

TEMPLATE_ATTRIBUTE

public static final String TEMPLATE_ATTRIBUTE

Common attribute used to specify the (Thymeleaf) template that should be used to render components of that type.

See Also:

Constant Field Values

METADATA_CLASS_ATTRIBUTE

public static final String METADATA_CLASS_ATTRIBUTE

Common attribute used to specify the fully qualified class name of the metadata for a particular component type.

See Also:

Constant Field Values

Constructor Detail

WebCmsComponentModel

@Deprecated
protected WebCmsComponentModel()

Deprecated.

WebCmsComponentModel

protected WebCmsComponentModel(WebCmsComponentType componentType)

WebCmsComponentModel

protected WebCmsComponentModel(WebCmsComponentModel template)

Base constructor for asComponentTemplate() calls, uses the parent component as template and attempts to convert the metadata to a new instance.

WebCmsComponentModel

protected WebCmsComponentModel(WebCmsComponent component)

Method Detail

getCustomTemplate

public String getCustomTemplate()

Implements ViewElement.getCustomTemplate(). This method returns the custom template that should be used for rendering this component model. If none is configured using #setRenderTemplate(String), the template set as TEMPLATE_ATTRIBUTE attribute on the WebCmsComponentType will be used.

Specified by:

getCustomTemplate in interface com.foreach.across.modules.web.ui.ViewElement

Returns:

optional custom template for rendering

See Also:

renderTemplate

hasMetadata

public boolean hasMetadata()

Returns:

true if there is metadata attached to this model

getMetadata

public <V extends U,U> V getMetadata(Class<U> metadataType)

Coerce the metadata to the type specified.

setComponent

public void setComponent(@NonNull
                         @NonNull WebCmsComponent component)

Set the original component backing this model, can never be null. If you want to create a new instance with all settings but remove the attachment to the original component, use asComponentTemplate().

Parameters:

component - that backs this model

getComponentType

public WebCmsComponentType getComponentType()

Returns:

Type of the WebCmsComponent.

getObjectId

public String getObjectId()

Specified by:

getObjectId in interface WebCmsObject

Returns:

unique object id of the component

setObjectId

public void setObjectId(String objectId)

Set the unique object id of the backing component

Parameters:

objectId - to use

getOwnerObjectId

public String getOwnerObjectId()

Returns:

the optional owner object id of the backing component

setOwner

public void setOwner(WebCmsObject owner)

Set the owner object of the backing component.

Parameters:

owner - instance

setOwnerObjectId

public void setOwnerObjectId(String ownerObjectId)

Set the owner object id of the backing component.

Parameters:

ownerObjectId - to use

hasOwner

public boolean hasOwner()

Returns:

true if the backing component has a specific owner

setTitle

public void setTitle(String title)

Set the title on the backing component.

Parameters:

title - to use

getTitle

public String getTitle()

Returns:

title (if set) or name

getName

public String getName()

Specified by:

getName in interface com.foreach.across.modules.web.ui.ViewElement

Returns:

the name of the backing component

setName

public void setName(String name)

Set the name on the backing component.

Parameters:

name - to use

getSortIndex

public int getSortIndex()

Returns:

sortIndex of the component in its owner scope

setSortIndex

public void setSortIndex(int sortIndex)

Parameters:

sortIndex - of the component in its owner scope

getDomain

public WebCmsDomain getDomain()

Specified by:

getDomain in interface WebCmsDomainBound

Returns:

domain of the component in its owner scope

setDomain

public void setDomain(WebCmsDomain domain)

Description copied from interface: WebCmsDomainBound

Set the WebCmsDomain this entity belongs to.

Specified by:

setDomain in interface WebCmsDomainBound

Parameters:

domain - of the component in its owner scope

getElementType

public final String getElementType()

Specified by:

getElementType in interface com.foreach.across.modules.web.ui.ViewElement

Returns:

fixed ViewElement type

isNew

public final boolean isNew()

Specified by:

isNew in interface WebCmsObject

Returns:

true if this model is an unpersisted component

asComponentTemplate

public abstract WebCmsComponentModel asComponentTemplate()

Convert the current model to a templated version: keep all properties but create a new backing component.

Returns:

templated version of this model - attached to a new backing component

See Also:

WebCmsComponent.asTemplate(), cloneMetadata(WebCmsComponentModel)

isEmpty

public abstract boolean isEmpty()

Base implementation that can be used to check if the component contains any relevant data.

Returns:

true if no relevant data is present

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

cloneMetadata

protected static Object cloneMetadata(WebCmsComponentModel componentModel)

Attempt to forcibly clone the metadata of a WebCmsComponentModel. Throws an exception if impossible.

Parameters:

componentModel - to clone the metadata from

Returns:

clone

See Also:

DtoUtils, EntityWithDto