com.beasys.commerce.foundation.property
Class SchemaImpl

java.lang.Object
  |
  +--com.beasys.commerce.foundation.EntityImpl
        |
        +--com.beasys.commerce.foundation.property.SchemaImpl

public class SchemaImpl

extends EntityImpl

The Schema entity bean is used to define meta data about properties that can be set on a ConfigurableEntity. The primary key class of the Schema entity bean includes the schemaGroupName and the scopeName. The schemaGroupName serves as a namespace so that scopeNames can conveniently re-used for different application areas. Typically, the schemaGroupName is used to define the application area and the scopeName uniquely identifies the Schema within the application area. The Schema EJB provides the finder findBySchemaGroupName that returns the collection of all Schemas for a given schemaGroupName. The Schema entity bean used a Map of PropertyMetaData objects to store the meta data about properties. The names of the properties are the keys in the Map.

See Also:

PropertyMetaData, Schema, SchemaHome, SchemaValue, Serialized Form

Field Summary

java.lang.String	description A textual description for the Schema.
SmartMapReference	propertyMetaData The Map of PropertyMetaData.
java.lang.String	schemaGroupName Specifies the schema namespace for this Schema.
long	schemaId Unique ID used for the relationship with PropertyMetaData.
java.lang.String	scopeName Specifies the scopeName within the schemaGroupName for this Schema.

Fields inherited from class com.beasys.commerce.foundation.EntityImpl

__classIdentifier, __containingEntity, __mapKey, __sequenceNumber, _ctx, _environmentNamingContext, _environmentPropertyCache, _isDirty, _smartBMP

Constructor Summary

SchemaImpl()

Method Summary

protected void	bscInitializeAttributes(SchemaPk schemaPk)
void	clearPropertyMetaData() Removes all mappings from this map (optional operation).
boolean	containsKeyPropertyMetaData(java.lang.Object key) Returns true if this map contains a mapping for the specified key.
boolean	containsValuePropertyMetaData(PropertyMetaData element) Returns true if this map maps one or more keys to the specified value.
void	ejbActivate() ejbActivate method.
SchemaPk	ejbCreate(SchemaPk schemaPk)
java.util.Enumeration	ejbFindAll() ejbFindAll method.
SchemaPk	ejbFindByPrimaryKey(SchemaPk pk)
java.util.Enumeration	ejbFindBySchemaGroupName(java.lang.String schemaGroupName) Finder method that returns the collection of Schema for a given schemaGroupName.
void	ejbLoad() ejbLoad method.
void	ejbPassivate() ejbPassivate method.
void	ejbPostCreate(SchemaPk schemaPk)
void	ejbRemove() ejbRemove method.
void	ejbStore() ejbStore method.
java.util.Set	entrySetPropertyMetaData() Returns a (deep copy) set view of the mappings contained in this map.
boolean	equalsPropertyMetaData(java.lang.Object object) Compares the specified object with this map for equality.
java.util.Map	getAllPropertyMetaData() Returns a deep copy of the entire collection
java.lang.String	getDescription() Get the value of description
PropertyMetaData	getPropertyMetaData(java.lang.Object key) Returns the value to which this map maps the specified key.
SmartMapReference	getPropertyMetaDataReference() Get the SmartMapReference for propertyMetaData
SchemaValue	getSchemaByValue() Get all of Schema's attributes.
java.lang.String	getSchemaGroupName()
long	getSchemaId() Get the value of schemaId.
java.lang.String	getScopeName()
int	hashCodePropertyMetaData() Returns the hash code value for this map.
boolean	isEmptyPropertyMetaData() Returns true if this map contains no key-value mappings.
java.util.Iterator	iteratorPropertyMetaData() Returns a (shallow) iterator for this map
java.util.Set	keySetPropertyMetaData() Returns a (deep copy) set view of the keys contained in this map.
void	putAllPropertyMetaData(java.util.Map map) Copies all of the mappings from the specified map to this map (optional operation).
PropertyMetaData	putPropertyMetaData(java.lang.Object key, PropertyMetaData element) Associates the specified value with the specified key in this map (optional operation).
PropertyMetaData	removePropertyMetaData(java.lang.Object key) Removes the mapping for this key from this map if present (optional operation).
void	setAllPropertyMetaData(java.util.Map map) Sets the entire collection
void	setDescription(java.lang.String description) Set the value of description
void	setEntityContext(javax.ejb.EntityContext ctx) setEntityContext method.
void	setPropertyMetaDataReference(SmartMapReference smartMapReference) Set the SmartCollectionReference for propertyMetaData
void	setSchemaByValue(SchemaValue value) Set all of Schema's attributes to the passed in value.
void	setSchemaGroupName(java.lang.String value)
void	setSchemaId(long schemaId) Set the value of schemaId.
void	setScopeName(java.lang.String value)
int	sizePropertyMetaData() Returns the number of key-value mappings in this map.
void	unsetEntityContext() unsetEntityContext method.
java.util.Collection	valuesPropertyMetaData() Returns a (deep copy) collection view of the values contained in this map.

Methods inherited from class com.beasys.commerce.foundation.EntityImpl

bscInitializeAttributes, clearRelationalBinding, clearRelationalBinding, clearRelationalBinding, clearRelationalBinding, doRelationalBinding, doRelationalBinding, doRelationalBindingOnElement, doRelationalBindingOnElement, doRelationalBindingOnElement, doRelationalBindingOnSingleton, doRelationalBindingOnSingleton, doRelationalBindingOnSingleton, doRelationalBindingWithMapKey, doRelationalBindingWithMapKey, doRelationalBindingWithMapKey, ejbCreate, ejbFindByPrimaryKey, ejbPostCreate, enumerateRelationalBinding, enumerateRelationalBinding, get__classIdentifier, get__containingBelonging, get__containingEntity, get__containingEntityReference, get__mapKey, get__sequenceNumber, getEntityContext, getEnvironmentNamingContext, getEnvironmentProperty, getEnvironmentProperty, getEnvironmentPropertyCache, getPersistenceHelperPlugin, getSmartBMP, initSmartBMP, isModified, set__classIdentifier, set__containingBelonging, set__containingEntity, set__containingEntityReference, set__mapKey

Methods inherited from class java.lang.Object

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

Field Detail

schemaGroupName

public java.lang.String schemaGroupName

Specifies the schema namespace for this Schema.

• Containment: By Value
• Multiplicity: 1:1
• PRIMARY KEY FIELD

scopeName

public java.lang.String scopeName

Specifies the scopeName within the schemaGroupName for this Schema.

• Containment: By Value
• Multiplicity: 1:1
• PRIMARY KEY FIELD

description

public java.lang.String description

A textual description for the Schema.

• Containment: By Value
• Multiplicity: 1:1

propertyMetaData

public SmartMapReference propertyMetaData

The Map of PropertyMetaData.

• Containment: By Value
• Multiplicity: 0:N
• Interface: java.util.Map

schemaId

public long schemaId

Unique ID used for the relationship with PropertyMetaData.

• Containment: By Value
• Multiplicity: 1:1

Constructor Detail

SchemaImpl

public SchemaImpl()

Method Detail

getSchemaByValue

public SchemaValue getSchemaByValue()

Get all of Schema's attributes.

Returns:

SchemaValue the Schema value object

setSchemaByValue

public void setSchemaByValue(SchemaValue value)

Set all of Schema's attributes to the passed in value. Note: Primary key attributes are not set.

Parameters:

SchemaValue - the Schema value object

ejbCreate

public SchemaPk ejbCreate(SchemaPk schemaPk)
                   throws javax.ejb.CreateException

bscInitializeAttributes

protected void bscInitializeAttributes(SchemaPk schemaPk)
                                throws javax.ejb.CreateException

ejbPostCreate

public void ejbPostCreate(SchemaPk schemaPk)
                   throws javax.ejb.CreateException

ejbLoad

public void ejbLoad()
             throws javax.ejb.EJBException

Description copied from class: EntityImpl

ejbLoad method.

Overrides:

ejbLoad in class EntityImpl

ejbStore

public void ejbStore()
              throws javax.ejb.EJBException

Description copied from class: EntityImpl

ejbStore method.

Overrides:

ejbStore in class EntityImpl

ejbRemove

public void ejbRemove()
               throws javax.ejb.RemoveException

Description copied from class: EntityImpl

ejbRemove method.

Overrides:

ejbRemove in class EntityImpl

ejbActivate

public void ejbActivate()
                 throws javax.ejb.EJBException

Description copied from class: EntityImpl

ejbActivate method.

Overrides:

ejbActivate in class EntityImpl

ejbPassivate

public void ejbPassivate()
                  throws javax.ejb.EJBException

Description copied from class: EntityImpl

ejbPassivate method.

Overrides:

ejbPassivate in class EntityImpl

setEntityContext

public void setEntityContext(javax.ejb.EntityContext ctx)
                      throws javax.ejb.EJBException

Description copied from class: EntityImpl

setEntityContext method.

Overrides:

setEntityContext in class EntityImpl

unsetEntityContext

public void unsetEntityContext()
                        throws javax.ejb.EJBException

Description copied from class: EntityImpl

unsetEntityContext method.

Overrides:

unsetEntityContext in class EntityImpl

ejbFindByPrimaryKey

public SchemaPk ejbFindByPrimaryKey(SchemaPk pk)
                             throws javax.ejb.FinderException

ejbFindAll

public java.util.Enumeration ejbFindAll()
                                 throws javax.ejb.FinderException

Description copied from class: EntityImpl

ejbFindAll method.

Overrides:

ejbFindAll in class EntityImpl

getSchemaGroupName

public java.lang.String getSchemaGroupName()

setSchemaGroupName

public void setSchemaGroupName(java.lang.String value)

getScopeName

public java.lang.String getScopeName()

setScopeName

public void setScopeName(java.lang.String value)

getDescription

public java.lang.String getDescription()

Get the value of description

Returns:

description.

setDescription

public void setDescription(java.lang.String description)

Set the value of description

Parameters:

description - description to be added

getPropertyMetaDataReference

public SmartMapReference getPropertyMetaDataReference()

Get the SmartMapReference for propertyMetaData

setPropertyMetaDataReference

public void setPropertyMetaDataReference(SmartMapReference smartMapReference)

Set the SmartCollectionReference for propertyMetaData

getAllPropertyMetaData

public java.util.Map getAllPropertyMetaData()

Returns a deep copy of the entire collection

setAllPropertyMetaData

public void setAllPropertyMetaData(java.util.Map map)

Sets the entire collection

iteratorPropertyMetaData

public java.util.Iterator iteratorPropertyMetaData()

Returns a (shallow) iterator for this map

clearPropertyMetaData

public void clearPropertyMetaData()

Removes all mappings from this map (optional operation).

containsKeyPropertyMetaData

public boolean containsKeyPropertyMetaData(java.lang.Object key)

Returns true if this map contains a mapping for the specified key.

containsValuePropertyMetaData

public boolean containsValuePropertyMetaData(PropertyMetaData element)

Returns true if this map maps one or more keys to the specified value.

entrySetPropertyMetaData

public java.util.Set entrySetPropertyMetaData()

Returns a (deep copy) set view of the mappings contained in this map.

equalsPropertyMetaData

public boolean equalsPropertyMetaData(java.lang.Object object)

Compares the specified object with this map for equality.

getPropertyMetaData

public PropertyMetaData getPropertyMetaData(java.lang.Object key)

Returns the value to which this map maps the specified key.

hashCodePropertyMetaData

public int hashCodePropertyMetaData()

Returns the hash code value for this map.

isEmptyPropertyMetaData

public boolean isEmptyPropertyMetaData()

Returns true if this map contains no key-value mappings.

keySetPropertyMetaData

public java.util.Set keySetPropertyMetaData()

Returns a (deep copy) set view of the keys contained in this map.

putPropertyMetaData

public PropertyMetaData putPropertyMetaData(java.lang.Object key,
                                            PropertyMetaData element)

Associates the specified value with the specified key in this map (optional operation).

putAllPropertyMetaData

public void putAllPropertyMetaData(java.util.Map map)

Copies all of the mappings from the specified map to this map (optional operation).

removePropertyMetaData

public PropertyMetaData removePropertyMetaData(java.lang.Object key)

Removes the mapping for this key from this map if present (optional operation).

sizePropertyMetaData

public int sizePropertyMetaData()

Returns the number of key-value mappings in this map.

valuesPropertyMetaData

public java.util.Collection valuesPropertyMetaData()

Returns a (deep copy) collection view of the values contained in this map.

getSchemaId

public long getSchemaId()

Get the value of schemaId.

Returns:

schemaId.

setSchemaId

public void setSchemaId(long schemaId)

Set the value of schemaId.

Parameters:

schemaId - schemaId to be added.

ejbFindBySchemaGroupName

public java.util.Enumeration ejbFindBySchemaGroupName(java.lang.String schemaGroupName)
                                               throws javax.ejb.FinderException

Finder method that returns the collection of Schema for a given schemaGroupName.