com.whitestein.lsps.lang

Class RecordWrapper

java.lang.Object

com.whitestein.lsps.lang.RecordWrapper

Direct Known Subclasses:

RecordColor, RecordDataSeries, RecordDataSeriesItem, RecordEvent, RecordFilterConfig, RecordFormComponent, RecordGeographicCoordinates, RecordGSDashboardWidget, RecordLabels, RecordPlotOptions, RecordRenderer, RecordResource, RecordSelectItem, RecordTableColumn

public abstract class RecordWrapper
extends Object

A record wrapper used as a common superclass for generated Java record wrappers.

Author:

mvo

Constructor Summary

Constructors

Constructor and Description
RecordWrapper() Creates a new record wrapper instance.
RecordWrapper(RecordHolder holder) Creates a new record wrapper instance.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap() Returns a map view of this record.
void	create(HolderFactory factory) Creates an underlying record holder.
boolean	equals(Object obj)
Object	getProperty(String name) Returns the property value.
abstract String	getTypeName() Returns the full type name of the record.
int	hashCode()
RecordHolder	holder() Returns the record holder.
boolean	isCreated() Returns true if the underlying record is created.
void	setProperty(String name, Object value) Sets the property value.
protected <E> Collection<E>	toCollection(CollectionHolder collection, Class<E> clazz, RecordWrapperFactory factory) Converts a given collection of LSPS records to record wrappers using a given factory.
protected <E> List<E>	toList(ListHolder list, Class<E> clazz, RecordWrapperFactory factory) Converts a given list of LSPS records to record wrappers using a given factory.
protected <E> Set<E>	toSet(SetHolder set, Class<E> clazz, RecordWrapperFactory factory) Converts a given set of LSPS records to record wrappers using a given factory.
String	toString() Returns a string representation of the wrapped holder.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordWrapper

public RecordWrapper()

Creates a new record wrapper instance.

RecordWrapper

public RecordWrapper(RecordHolder holder)

Creates a new record wrapper instance.

Parameters:

holder -

Method Detail

getTypeName

public abstract String getTypeName()

Returns the full type name of the record.

Returns:

the full type name of the record

holder

public final RecordHolder holder()

Returns the record holder.

Returns:

the record holder

isCreated

public final boolean isCreated()

Returns true if the underlying record is created.

Returns:

true if the underlying record is created

getProperty

public final Object getProperty(String name)

Returns the property value.

Parameters:

name - a property name

Returns:

the property value

setProperty

public final void setProperty(String name,
                              Object value)

Sets the property value.

Parameters:

name - a property name

value - a new property value

create

public final void create(HolderFactory factory)

Creates an underlying record holder. If the record is already created, an IllegalStateException is thrown.

Parameters:

factory -

asMap

public final Map<String,Object> asMap()

Returns a map view of this record.

Returns:

a map view of this record

toString

public String toString()

Returns a string representation of the wrapped holder.

Overrides:

toString in class Object

Returns:

a string representation of the wrapped holder

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toSet

protected <E> Set<E> toSet(SetHolder set,
                           Class<E> clazz,
                           RecordWrapperFactory factory)

Converts a given set of LSPS records to record wrappers using a given factory.

Type Parameters:

E -

Parameters:

set -

clazz -

factory -

Returns:

the created set

toList

protected <E> List<E> toList(ListHolder list,
                             Class<E> clazz,
                             RecordWrapperFactory factory)

Converts a given list of LSPS records to record wrappers using a given factory.

Type Parameters:

E -

Parameters:

list -

clazz -

factory -

Returns:

the created list

toCollection

protected <E> Collection<E> toCollection(CollectionHolder collection,
                                         Class<E> clazz,
                                         RecordWrapperFactory factory)

Converts a given collection of LSPS records to record wrappers using a given factory.

Type Parameters:

E -

Parameters:

collection -

clazz -

factory -

Returns:

the created collection