BelongingImpl Class

com.beasys.commerce.foundation
BelongingImpl Class

public abstract class BelongingImpl

    extends Object
    implements Belonging, RelationalReference

The BelongingImpl provides the abstract base class from which all Belonging implementations must be derived. It implements the Belonging interface and serves as its symmetric counterpart.

Related Topics

Belonging
SmartHome

Hierarchy
Object
  BelongingImpl
All Implemented Interfaces

Belonging, BusinessSmartComponent, Cloneable, Comparable, RelationalReference, Serializable
Direct Known Subclasses

ImageInfoImpl, InventoryInfoImpl, JspInfoImpl, MoneyImpl, OrderLineImpl, QualityImpl, QuantityImpl, ResultImpl, ShoppingCartImpl, ShoppingCartLineImpl, StateImpl, TaxInformationImpl, TaxLineImpl, TaxLineListImpl, TaxLineResultImpl, TaxParametersImpl, TaxResultImpl, TransactionEntryImpl, TransitionImpl, UnitImpl, UnitPriceImpl

Field Summary
public String
__classIdentifier
String
public Belonging
__containingBelonging
Belonging
public SmartEntityReference
__containingEntity
SmartEntityReference
public Object
__mapKey
Object
public Long
__sequenceNumber
Long
public transient boolean
_isDirty
boolean
 

Constructor Summary
BelongingImpl()

Default constructor.
 

Method Summary
public final void
clearRelationalBinding(String attributeIdentifier, Collection collection)
public final void
clearRelationalBinding(String attributeIdentifier, Collection collection, Object o)
public final void
clearRelationalBinding(String attributeIdentifier, Map map, Object key)
public final void
clearRelationalBinding(String attributeIdentifier, Map map)
public final Object
clone()
Returns a shallow copy of the Belonging instance.
public abstract int
compareTo(Object o)
Compares a given object with this Belonging.
protected final Collection
doRelationalBinding(String attributeIdentifier, Collection collection)
Add relational information to each element in a collection, AND synchronize the collection with the persistence cache This feature is implemented by a plugin and by default is turned off
protected final Map
doRelationalBinding(String attributeIdentifier, Map map)
Add relational information to each element in a map, AND synchronize the map with the persistence cache This feature is implemented by a plugin and by default is turned off
protected final Object
doRelationalBindingOnElement(String attributeIdentifier, Object value)
Add relational information to a dependent object.
protected final Belonging
doRelationalBindingOnElement(String attributeIdentifier, Belonging value)
Add relational information to a belonging This feature is implemented by a plugin and by default is turned off
protected final EJBObject
doRelationalBindingOnElement(String attributeIdentifier, EJBObject value)
Add relational information to an EJBObject This feature is implemented by a plugin and by default is turned off
protected final Object
doRelationalBindingOnSingleton(String attributeIdentifier, Object value)
Add relational information to a dependent object.
protected final Belonging
doRelationalBindingOnSingleton(String attributeIdentifier, Belonging value)
Add relational information to a belonging This feature is implemented by a plugin and by default is turned off
protected final EJBObject
doRelationalBindingOnSingleton(String attributeIdentifier, EJBObject ejbObject)
Add relational information to an EJBObject This feature is implemented by a plugin and by default is turned off
protected final Object
doRelationalBindingWithMapKey(String attributeIdentifier, Object object, Object key)
Add relational information to an element in a map, AND synchronize the element with the persistence cache This feature is implemented by a plugin and by default is turned off
protected final EJBObject
doRelationalBindingWithMapKey(String attributeIdentifier, EJBObject ejbObject, Object key)
Add relational information to an element in a map, AND synchronize the element with the persistence cache This feature is implemented by a plugin and by default is turned off
protected final Object
doRelationalBindingWithMapKey(String attributeIdentifier, Belonging belonging, Object key)
Add relational information to an element in a map, AND synchronize the element with the persistence cache This feature is implemented by a plugin and by default is turned off
protected final Collection
enumerateRelationalBinding(String attributeIdentifier, Collection collection)
Add relational information to each element in a collection, but do not synchronize the collection with the persistence cache This feature is implemented by a plugin and by default is turned off
protected final Map
enumerateRelationalBinding(String attributeIdentifier, Map map)
Add relational information to each element in a map, but do not synchronize the map with the persistence cache This feature is implemented by a plugin and by default is turned off
public final boolean
equals(Object o)
Indicates whether some other Belonging is equivalent to this Belonging.
public String
get__classIdentifier()
Get class identifier for this object (used to persist subclasses in a single collection or map)
public Belonging
get__containingBelonging()
Get foreign key information about the bean that contains this object
public EJBObject
get__containingEntity()
Get foreign key information about the bean that contains this object
public SmartEntityReference
get__containingEntityReference()
public Object
get__mapKey()
get map key
public Long
get__sequenceNumber()
Get the sequencer number
public final PersistenceHelperPlugin
getPersistenceHelperPlugin()
Instantiates PersistenceHelperPlugin for this Belonging using properties specified in the Server property file.
public int
hashCode()
Returns a hash code for this Belonging.
protected void
set__classIdentifier(String classIdentifier)
Derived classes use this to set the class identifier
public void
set__containingBelonging(Belonging belonging)
Provides foreign key information about the bean that contains this object
public void
set__containingEntity(EJBObject containingEntity)
Provides foreign key information about the bean that contains this object
public void
set__containingEntityReference(SmartEntityReference smartEntityReference)
public void
set__mapKey(Object mapKey)
Provides map key information
public void
setByValue(Belonging belonging)
Intializes the Belonging based upon a supplied Belonging.
public String
toString()
Returns a String representation of the Belonging.
 
Methods from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
   
Methods from interface com.beasys.commerce.foundation.Belonging
clone, equals, interfaceName, setByValue, value
 
Methods from interface java.lang.Comparable
compareTo
 
Methods from interface com.beasys.commerce.foundation.RelationalReference
get__classIdentifier, get__containingBelonging, get__containingEntity, get__mapKey, get__sequenceNumber, set__containingBelonging, set__containingEntity, set__mapKey
 

Field Detail

__classIdentifier

public String __classIdentifier

__containingBelonging

public Belonging __containingBelonging

__containingEntity

public SmartEntityReference __containingEntity

__mapKey

public Object __mapKey

__sequenceNumber

public Long __sequenceNumber

_isDirty

public transient boolean _isDirty

 

Constructor Detail

BelongingImpl

public BelongingImpl()
Default constructor.
 

Method Detail

clearRelationalBinding(String, Collection) Method

public final void clearRelationalBinding(String attributeIdentifier, 
                                         Collection collection)

clearRelationalBinding(String, Collection, Object) Method

public final void clearRelationalBinding(String attributeIdentifier, 
                                         Collection collection, 
                                         Object o)

clearRelationalBinding(String, Map, Object) Method

public final void clearRelationalBinding(String attributeIdentifier, 
                                         Map map, 
                                         Object key)

clearRelationalBinding(String, Map) Method

public final void clearRelationalBinding(String attributeIdentifier, 
                                         Map map)

clone() Method

public final Object clone()
Returns a shallow copy of the Belonging instance.

Overrides
Object.clone()

Returns

A shallow copy of this Belonging.

compareTo(Object) Method

public abstract int compareTo(Object o)
Compares a given object with this Belonging.

Parameters

o
the Object to be compared.

Returns

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

doRelationalBinding(String, Collection) Method

protected final Collection doRelationalBinding(String attributeIdentifier, 
                                               Collection collection)
Add relational information to each element in a collection, AND synchronize the collection with the persistence cache This feature is implemented by a plugin and by default is turned off

Parameters

attributeIdentifier
identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers
collection
the target collection

Returns

the input collection

doRelationalBinding(String, Map) Method

protected final Map doRelationalBinding(String attributeIdentifier, 
                                        Map map)
Add relational information to each element in a map, AND synchronize the map with the persistence cache This feature is implemented by a plugin and by default is turned off

Parameters

attributeIdentifier
identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers
map
the target map

Returns

the input map

doRelationalBindingOnElement(String, Object) Method

protected final Object doRelationalBindingOnElement(String attributeIdentifier, 
                                                    Object value)
Add relational information to a dependent object. This feature is implemented by a plugin and by default is turned off

Parameters

attributeIdentifier
identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers
value
instance of a dependent object

Returns

the input value with relational information added.

doRelationalBindingOnElement(String, Belonging) Method

protected final Belonging doRelationalBindingOnElement(String attributeIdentifier, 
                                                       Belonging value)
Add relational information to a belonging This feature is implemented by a plugin and by default is turned off

Parameters

attributeIdentifier
identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers
value
instance of a belonging

Returns

the input value, with relational inforamtion added.

doRelationalBindingOnElement(String, EJBObject) Method

protected final EJBObject doRelationalBindingOnElement(String attributeIdentifier, 
                                                       EJBObject value)
Add relational information to an EJBObject This feature is implemented by a plugin and by default is turned off

Parameters

attributeIdentifier
identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers
value
instance of an EJB object

Returns

the input value, with relational information added.

doRelationalBindingOnSingleton(String, Object) Method

protected final Object doRelationalBindingOnSingleton(String attributeIdentifier, 
                                                      Object value)
Add relational information to a dependent object. This feature is implemented by a plugin and by default is turned off

Parameters

attributeIdentifier
identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers
value
instance of a dependent object

Returns

the input value with relational information added.

doRelationalBindingOnSingleton(String, Belonging) Method

protected final Belonging doRelationalBindingOnSingleton(String attributeIdentifier, 
                                                         Belonging value)
Add relational information to a belonging This feature is implemented by a plugin and by default is turned off

Parameters

attributeIdentifier
identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers
value
instance of a belonging

Returns

the input value, with relational inforamtion added.

doRelationalBindingOnSingleton(String, EJBObject) Method

protected final EJBObject doRelationalBindingOnSingleton(String attributeIdentifier, 
                                                         EJBObject ejbObject)
Add relational information to an EJBObject This feature is implemented by a plugin and by default is turned off

Parameters

attributeIdentifier
identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers
ejbObject
instance of an EJB object

Returns

the input value, with relational information added.

doRelationalBindingWithMapKey(String, Object, Object) Method

protected final Object doRelationalBindingWithMapKey(String attributeIdentifier, 
                                                     Object object, 
                                                     Object key)
Add relational information to an element in a map, AND synchronize the element with the persistence cache This feature is implemented by a plugin and by default is turned off

Parameters

attributeIdentifier
identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers
object
the target collection

Returns

the input collection

doRelationalBindingWithMapKey(String, EJBObject, Object) Method

protected final EJBObject doRelationalBindingWithMapKey(String attributeIdentifier, 
                                                        EJBObject ejbObject, 
                                                        Object key)
Add relational information to an element in a map, AND synchronize the element with the persistence cache This feature is implemented by a plugin and by default is turned off

Parameters

attributeIdentifier
identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers
ejbObject
the target collection

Returns

the input collection

doRelationalBindingWithMapKey(String, Belonging, Object) Method

protected final Object doRelationalBindingWithMapKey(String attributeIdentifier, 
                                                     Belonging belonging, 
                                                     Object key)
Add relational information to an element in a map, AND synchronize the element with the persistence cache This feature is implemented by a plugin and by default is turned off

Parameters

attributeIdentifier
identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers
belonging
the target collection

Returns

the input collection

enumerateRelationalBinding(String, Collection) Method

protected final Collection enumerateRelationalBinding(String attributeIdentifier, 
                                                      Collection collection)
Add relational information to each element in a collection, but do not synchronize the collection with the persistence cache This feature is implemented by a plugin and by default is turned off

Parameters

attributeIdentifier
identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers
collection
the target collection

Returns

the input collection

enumerateRelationalBinding(String, Map) Method

protected final Map enumerateRelationalBinding(String attributeIdentifier, 
                                               Map map)
Add relational information to each element in a map, but do not synchronize the map with the persistence cache This feature is implemented by a plugin and by default is turned off

Parameters

attributeIdentifier
identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers
map
the target map

Returns

the input map

equals(Object) Method

public final boolean equals(Object o)
Indicates whether some other Belonging is equivalent to this Belonging.

Overrides
Object.equals(Object)

Parameters

o
the Object to be compared.

Returns

true if the supplied Object is equivalent, false otherwise.

get__classIdentifier() Method

public String get__classIdentifier()
Get class identifier for this object (used to persist subclasses in a single collection or map)

Returns

class identifier for this object.

get__containingBelonging() Method

public Belonging get__containingBelonging()
Get foreign key information about the bean that contains this object

Returns

ejbObject remote interface of the containing bean

get__containingEntity() Method

public EJBObject get__containingEntity()
Get foreign key information about the bean that contains this object

Returns

ejbObject remote interface of the containing bean

get__containingEntityReference() Method

public SmartEntityReference get__containingEntityReference()

get__mapKey() Method

public Object get__mapKey()
Description copied from RelationalReference.get__mapKey()
get map key

Returns

the mak key

get__sequenceNumber() Method

public Long get__sequenceNumber()
Get the sequencer number

getPersistenceHelperPlugin() Method

public final PersistenceHelperPlugin getPersistenceHelperPlugin()
Instantiates PersistenceHelperPlugin for this Belonging using properties specified in the Server property file. A plugin can be specified on a per Belonging class basis or as a default. This method uses the PersistenceHelperPlugin factory.

Returns

PersistenceHelperPlugin specific class that implements PersistenceHelperPlugin or null, if no PersistenceHelperPlugin is specified.

hashCode() Method

public int hashCode()
Returns a hash code for this Belonging.

Overrides
Object.hashCode()

Returns

The hash code for this Belonging.

set__classIdentifier(String) Method

protected void set__classIdentifier(String classIdentifier)
Derived classes use this to set the class identifier

set__containingBelonging(Belonging) Method

public void set__containingBelonging(Belonging belonging)
Provides foreign key information about the bean that contains this object

Parameters

belonging
remote interface of the containing bean

set__containingEntity(EJBObject) Method

public void set__containingEntity(EJBObject containingEntity)
Provides foreign key information about the bean that contains this object

Parameters

containingEntity
remote interface of the containing bean

set__containingEntityReference(SmartEntityReference) Method

public void set__containingEntityReference(SmartEntityReference smartEntityReference)

set__mapKey(Object) Method

public void set__mapKey(Object mapKey)
Description copied from RelationalReference.set__mapKey(Object)
Provides map key information

Parameters

mapKey
the key if this object is used in a map

setByValue(Belonging) Method

public void setByValue(Belonging belonging)
Intializes the Belonging based upon a supplied Belonging.

Parameters

belonging
The Belonging to use for initialization.

toString() Method

public String toString()
Returns a String representation of the Belonging.

Overrides
Object.toString()

Returns

A String representation of the Belonging.