pl.decerto.hyperon.persistence.model.value

Class Bundle

java.lang.Object

pl.decerto.hyperon.persistence.model.value.Property

pl.decerto.hyperon.persistence.model.value.EntityProperty

pl.decerto.hyperon.persistence.model.value.Bundle

All Implemented Interfaces:

Iterable<Property>, Handle

public class Bundle
extends EntityProperty

This is main class, that developer can interact with using hyperon persistence engine. In general, this class should store all data, that should be managed by persistence engine. Bundle is a root for Hyperon context. What's really important is that data, should match BundleDef definition. Bundle stores basic information like:

• def - bundle definition, which holds type structure of created bundle
• revision - incremental number of updated bundle. By default, it starts with 0 on init, but on first persist it will store 1
• created - creation time, only setup on first persistence call
• updated - update time, on first persistence call it is null, but for next revisions this field will be updated
• lobHash - last hash code of serialized JSON

Example of bundle creation and setup some properties:

 	Bundle bundle = new Bundle(def); // def must match properties that are setup later

 	Property steph = bundle.create("Client").set("age", 31).set("name", "steph");
 	Property dean = bundle.create("Client").set("age", 32).set("name", "dean");
 	Property alex = bundle.create("Client").set("age", 33).set("name", "alex");

 	bundle.get("agent").set(steph);
 	bundle.get("policy.insurer").set(dean);
 	bundle.get("policy.insured").set(alex);
 

Bundle can be used with Hyperon context mechanism. The best way to do that is to work with AppCtx.

Author:

przemek hertel

See Also:

BundleDef, AppCtx

Constructor Summary

Constructors

Constructor and Description
Bundle(BundleDef def) Basic constructor to use with definition.
Bundle(BundleDef def, long id) Shouldn't be used outside of Hyperon persistence engine.
Bundle(BundleDef def, long id, int revision) Shouldn't be used outside of Hyperon persistence engine.
Bundle(BundleDef def, long id, int revision, int expectedSize) Shouldn't be used outside of Hyperon persistence engine.

Method Summary

Modifier and Type	Method and Description
Bundle	add(String name, Property prop) Adds given property under provided name.
boolean	contains(Property prop) Checks if given prop property exists within bundle.
Property	create(String type) Create instance of property, that matches given type name from associated bundle definition.
Bundle	deepcopy() Same as deepcopy(boolean), but with flag set to true.
Bundle	deepcopy(boolean resetIds) Creates new bundle instance with copied: all bundle data internal fields references It applies to all nested properties within bundle root.
boolean	equals(Object o)
Set<Property>	getAll() Get all properties within bundle.
Date	getCreated() Get bundle's creation time.
BundleDef	getDef() Get bundle's definition.
int	getLobHash() Get last lob hash.
int	getRevision() Get bundle's revision.
Date	getUpdated() Get bundle's last update time
int	hashCode()
IdentitySet	identitySet() Returns identity set with nested properties.
boolean	isNotSaved() Checks if bundle was not saved yet.
boolean	isRoot() Since bundle is always a root, it will return true.
boolean	isSaved() Checks if bundle was saved already.
String	print() This will print bundle with specific format.
Property	remove() This method is not supported.
void	setCreated(Date created) Shouldn't be used outside of Hyperon persistence engine.
void	setLobHash(int lobHash) Shouldn't be used outside of Hyperon persistence engine.
void	setRevision(int revision) Shouldn't be used outside of Hyperon persistence engine.
void	setUpdated(Date updated) Shouldn't be used outside of Hyperon persistence engine.
String	toString() Formatted String as follows: EntityProperty[name#23, @432423432, owner=101, fields=field1, refc=2]
void	walk(PropertyVisitor visitor) This method allows to walk on each property using provided visitor and do some action.
void	walk(PropertyVisitor visitor, boolean usePathsInVisitor) Deprecated. this method shouldn't be used anymore. Please use walk(PropertyVisitor).

Methods inherited from class pl.decerto.hyperon.persistence.model.value.EntityProperty

create, find, getElementType, getFields, getId, getProp, getState, getValue, has, isEntity, mark, print, printValues, resetIds, set, setBundle, setId, size

Methods inherited from class pl.decerto.hyperon.persistence.model.value.Property

add, add, asCollection, asEntity, asRef, asValue, at, booleanValue, booleanValue, bundle, clear, get, getBoolean, getBoolean, getBundle, getCanonicalPath, getCollection, getContainer, getDate, getDate, getDatetime, getDatetime, getDecimal, getDecimal, getEntity, getHolder, getHolder, getInteger, getInteger, getLong, getLong, getName, getNumber, getNumber, getOwnerId, getOwnerPropertyName, getParent, getParentName, getPath, getRefCount, getRefTarget, getString, getString, getType, getTypeCode, intValue, intValue, isCollection, isPersistent, isTransient, isValue, iterator, remove, set, setContainer, setName, setOwnerId, setParent, setupOwnerId, traverse, traverse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface pl.decerto.hyperon.persistence.model.value.Handle

isRef

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Bundle

public Bundle(BundleDef def)

Basic constructor to use with definition. Id of created bundle will be 0. This one should be used for bundle creation.

Parameters:

def - bundle definition

Bundle

public Bundle(BundleDef def,
              long id)

Shouldn't be used outside of Hyperon persistence engine. Basic constructor with definition and id.

Parameters:

def - bundle definition

id - bundle id

Bundle

public Bundle(BundleDef def,
              long id,
              int revision)

Shouldn't be used outside of Hyperon persistence engine. Basic constructor with definition, id and revision.

Parameters:

def - bundle definition

id - bundle id

revision - bundle revision starting number

Bundle

public Bundle(BundleDef def,
              long id,
              int revision,
              int expectedSize)

Shouldn't be used outside of Hyperon persistence engine. Advanced constructor with definition, id, revision and expected size of identity set(storage for nested properties).

Parameters:

def - bundle definition

id - bundle id

revision - bundle revision starting number

expectedSize - size of created identity set

Method Detail

add

public Bundle add(String name,
                  Property prop)

Adds given property under provided name. It is another way of setting properties within bundle.

Overrides:

add in class EntityProperty

Parameters:

name - unique name

prop - property to store under name

Returns:

same bundle instance

See Also:

EntityProperty.set(Object), Property.set(String, Object)

isRoot

public boolean isRoot()

Since bundle is always a root, it will return true.

Specified by:

isRoot in interface Handle

Overrides:

isRoot in class Property

Returns:

true

See Also:

Bundle

getRevision

public int getRevision()

Get bundle's revision.

Returns:

bundle's revision

setRevision

public void setRevision(int revision)

Shouldn't be used outside of Hyperon persistence engine.

Parameters:

revision - revision number

getCreated

public Date getCreated()

Get bundle's creation time.

Returns:

bundle's creation time

setCreated

public void setCreated(Date created)

Shouldn't be used outside of Hyperon persistence engine.

Parameters:

created - creation date

getUpdated

public Date getUpdated()

Get bundle's last update time

Returns:

bundle's last update time

setUpdated

public void setUpdated(Date updated)

Shouldn't be used outside of Hyperon persistence engine.

Parameters:

updated - update date

setLobHash

public void setLobHash(int lobHash)

Shouldn't be used outside of Hyperon persistence engine.

Parameters:

lobHash - lob hash

getLobHash

public int getLobHash()

Get last lob hash.

Returns:

last lob hash

getDef

public BundleDef getDef()

Get bundle's definition.

Returns:

bundle's definition

isNotSaved

public boolean isNotSaved()

Checks if bundle was not saved yet.

Returns:

true if id == 0, false otherwise

isSaved

public boolean isSaved()

Checks if bundle was saved already.

Returns:

true if id != 0, false otherwise

create

public Property create(String type)

Create instance of property, that matches given type name from associated bundle definition.

Parameters:

type - from bundle definition

Returns:

created new EntityProperty instance

Throws:

HyperonPersistenceException - if type is not defined within bundle definition

identitySet

public IdentitySet identitySet()

Returns identity set with nested properties. It is exposed for IdentityScanner usage. This method shouldn't be used to access elements of bundle and especially modify it's content.

Returns:

identity set of properties

See Also:

IdentityScanner

contains

public boolean contains(Property prop)

Checks if given prop property exists within bundle.

Parameters:

prop - property to check

Returns:

true if exists, false otherwise

getAll

public Set<Property> getAll()

Get all properties within bundle.

Returns:

set of properties

deepcopy

public Bundle deepcopy(boolean resetIds)

Creates new bundle instance with copied:

• all bundle data
• internal fields
• references

It applies to all nested properties within bundle root.
Extra flag is responsible for resetting ids, if set to true.

Overrides:

deepcopy in class EntityProperty

Parameters:

resetIds - control flag, if true then bundle and all elements will have id's set to 0, if false, id will be copied

Returns:

new instance of bundle with copied properties

See Also:

Property.deepcopy()

deepcopy

public Bundle deepcopy()

Same as deepcopy(boolean), but with flag set to true.

Overrides:

deepcopy in class Property

Returns:

new instance of bundle with copied properties and reset ids

equals

public boolean equals(Object o)

Overrides:

equals in class EntityProperty

hashCode

public int hashCode()

Overrides:

hashCode in class EntityProperty

walk

public void walk(PropertyVisitor visitor)

This method allows to walk on each property using provided visitor and do some action.

Parameters:

visitor - property visitor implementation

See Also:

PropertyVisitor.visit(Property, ElementType)

walk

@Deprecated
public void walk(PropertyVisitor visitor,
                             boolean usePathsInVisitor)

Deprecated. this method shouldn't be used anymore. Please use walk(PropertyVisitor).

Parameters:

visitor - property visitor implementation

usePathsInVisitor - control flag, if set to true it will trigger new implementation, false the old one.

remove

public Property remove()

This method is not supported.

Specified by:

remove in interface Handle

Overrides:

remove in class Property

Returns:

nothing

Throws:

UnsupportedOperationException - this is not supported on root bundle level

print

public String print()

This will print bundle with specific format.
Example:

   bundle D: Bundle[id=0, revision=0]
   * agent  (Client#0  @60861)
     - pesel = null  (string)
     * age = 11  (integer)
   * policy  (Policy#0  @12577)
     * building  (Building#0  @23246)
       * area = 99  (integer)
     * clients  collection(Client)  size=1
       * clients[0]  (Client#0  @31764)
         - addr  (Address#0  @49659)
 

Specified by:

print in interface Handle

Overrides:

print in class Property

Returns:

formatted string

See Also:

Property, ValueProperty, EntityProperty, CollectionProperty, RefProperty

toString

public String toString()

Description copied from class: EntityProperty

Formatted String as follows:

  EntityProperty[name#23, @432423432, owner=101, fields=field1, refc=2]
 

Overrides:

toString in class EntityProperty

Returns:

formatted String