net.eusashead.parquet.entity

Interface Entity

All Known Implementing Classes:

BasicEntity

public interface Entity

Method Summary

Methods

Modifier and Type	Method and Description
EntityBuilder	entityBuilder() Get an EntityBuilder pre-filled with the state of this Entity to create a mutable clone as Entity instances must be immutable
Link	getLink(java.lang.String rel) Get the named Link
java.util.Map<java.lang.String,Link>	getLinks() Return all Link in a Map keyed with the name
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Get all properties in a Map keyed with the name of the property
java.lang.Object	getProperty(java.lang.String key) Get the named property as an Object
<T> T	getProperty(java.lang.String key, java.lang.Class<T> convertTo) Get a property with type by casting to the supplied class
java.lang.String	getProperty(java.lang.String key, java.text.Format format) Get a property as a formattted string using the supplied Format
<T> T	getProperty(java.lang.String key, PropertyConverter<T,java.lang.Object> converter) Get a property with the type converted from Object using the supplied PropertyConverter
java.util.Collection<Entity>	getRelation(java.lang.String rel) Get the named relation
java.util.Map<java.lang.String,java.util.Collection<Entity>>	getRelations() Get a Map containing all related Entity keyed with name (rel).

Method Detail

getLinks

java.util.Map<java.lang.String,Link> getLinks()

Return all Link in a Map keyed with the name

Returns:

Map of Link

getLink

Link getLink(java.lang.String rel)

Get the named Link

Parameters:

rel - name of Link

Returns:

Link matching name or null

getProperty

java.lang.Object getProperty(java.lang.String key)

Get the named property as an Object

Parameters:

key - name of property

Returns:

property in Object form

getProperty

<T> T getProperty(java.lang.String key,
                java.lang.Class<T> convertTo)

Get a property with type by casting to the supplied class

Parameters:

key -

convertTo -

Returns:

getProperty

<T> T getProperty(java.lang.String key,
                PropertyConverter<T,java.lang.Object> converter)

Get a property with the type converted from Object using the supplied PropertyConverter

Parameters:

key - name of property to convert and return

converter - PropertyConverter to perform conversions

Returns:

property converted to type

getProperty

java.lang.String getProperty(java.lang.String key,
                           java.text.Format format)

Get a property as a formattted string using the supplied Format

Parameters:

key -

format -

Returns:

getProperties

java.util.Map<java.lang.String,java.lang.Object> getProperties()

Get all properties in a Map keyed with the name of the property

Returns:

Map of properties

getRelations

java.util.Map<java.lang.String,java.util.Collection<Entity>> getRelations()

Get a Map containing all related Entity keyed with name (rel).

Returns:

Map with Entity

getRelation

java.util.Collection<Entity> getRelation(java.lang.String rel)

Get the named relation

Parameters:

rel - String name of the relation to fetch

Returns:

a Collection of Entity that have this name

entityBuilder

EntityBuilder entityBuilder()

Get an EntityBuilder pre-filled with the state of this Entity to create a mutable clone as Entity instances must be immutable

Returns:

EntityBuilder for this Entity