com.foreach.across.modules.webcms.data

Class WebCmsDataEntry

java.lang.Object

com.foreach.across.modules.webcms.data.WebCmsDataEntry

public final class WebCmsDataEntry
extends Object

Represents a set of data to be imported. Data should be either a Map or a Collection (usually of Map items).

Since:

0.0.1

Author:

Arne Vandamme

See Also:

WebCmsDataImportServiceImpl, WebCmsDataImportAction

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROOT

Method Summary

Modifier and Type	Method and Description
void	addCompletedCallback(Consumer consumer) Adds a callback to execute once the data entry is completed
String	getLocation() Attempt to build a relative location of this data entry in the parent data.
String	getParentKey() Shortcut to retrieve the key of the optional parent data.
<V,U extends V> U	getSingleValue(Class<V> expectedType) Get the single value and cast it to the expected type.
boolean	hasParent()
boolean	isCollectionData()
boolean	isMapData()
boolean	isSingleValue()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ROOT

public static final String ROOT

See Also:

Constant Field Values

Method Detail

isMapData

public boolean isMapData()

Returns:

true if data is of type map

isCollectionData

public boolean isCollectionData()

Returns:

true if data is of type collection

getSingleValue

public <V,U extends V> U getSingleValue(Class<V> expectedType)

Get the single value and cast it to the expected type.

Type Parameters:

V - expected type

U - specific (generic-aware) implementation of the expected type

Parameters:

expectedType - to cast to

Returns:

single value as type

isSingleValue

public boolean isSingleValue()

Returns:

true if data is a single (usually primitive) value

hasParent

public boolean hasParent()

Returns:

true if the data entry has a parent data entry

getParentKey

public String getParentKey()

Shortcut to retrieve the key of the optional parent data.

Returns:

parent key or null if no parent data

getLocation

public String getLocation()

Attempt to build a relative location of this data entry in the parent data.

Returns:

location (null if no parent)

toString

public String toString()

Overrides:

toString in class Object

addCompletedCallback

public void addCompletedCallback(Consumer consumer)

Adds a callback to execute once the data entry is completed

Parameters:

consumer - the callback