com.beasys.commerce.axiom.document
Class SPISchemaSmartBMP

java.lang.Object
  |
  +--com.beasys.commerce.axiom.document.SPISchemaSmartBMP

public class SPISchemaSmartBMP

extends java.lang.Object

implements SmartBMP

A SmartBMP for a SchemeImpl which can pull the information from the DocMgmt Component's SPI JDBC driver.

Since:

2.0

Field Summary

static java.util.Map

defaultPropertyMetaData The map of attribute name to PropertyMetaData for the explicit document objects.

Constructor Summary

SPISchemaSmartBMP()

Method Summary

void	close(java.sql.Connection con) Helper method to close a connection, ignoring any exceptions.
static void	close(DocumentIterator iterator) Close a document iterator, ignoring any exceptions.
static void	close(java.sql.Statement stmt) Helper method to close a statement, ignoring any sql exceptions.
void	create(SmartKey smartKey, EntityImpl entityImpl) Implements BMP functionality of ejbCreate() method.
static PropertyMetaData	createExplicitPropertyMetaData(java.lang.String desc, int type) Create a PropertyMetaData for an explicit non-multi-valued attribute.
boolean	exists(SmartKey smartKey, EntityImpl imp) Indicates if a bean with the specified primary key exists in the persistent store.
java.util.Enumeration	findAll(EntityImpl impl) Implements BMP functionality of ejbFindAll() method.
java.util.Enumeration	findBySchemaGroupName(java.lang.String groupName, EntityImpl impl) Find all the schema by a schema group name.
void	refresh(SmartKey smartKey, EntityImpl entityImpl) Implements BMP functionality of ejbLoad() method.
void	remove(SmartKey smartKey) Implements BMP functionality of ejbRemove() method.
void	remove(SmartKey key, EntityImpl impl) Implements BMP functionality of ejbRemove() method.
void	update(SmartKey smartKey, EntityImpl entityImpl) Implements BMP functionality of ejbStore() and ejbPostCreate() methods.

Methods inherited from class java.lang.Object

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

Field Detail

defaultPropertyMetaData

public static final java.util.Map defaultPropertyMetaData

The map of attribute name to PropertyMetaData for the explicit document objects.

This unmodifiable map can be used to populate Schema objects with the explicit property information for a Document. Chaning the contained PropertyMetaData objects will have adverse effects and is not supported.

Constructor Detail

SPISchemaSmartBMP

public SPISchemaSmartBMP()

Method Detail

createExplicitPropertyMetaData

public static PropertyMetaData createExplicitPropertyMetaData(java.lang.String desc,
                                                              int type)

Create a PropertyMetaData for an explicit non-multi-valued attribute.

Parameters:

desc - the description.

type - the TypesHelper type of the attribute.

create

public void create(SmartKey smartKey,
                   EntityImpl entityImpl)
            throws BMPException

Implements BMP functionality of ejbCreate() method.

Initialize the representation of the entity bean in persistent store using the smartKey as primary key. Attributes of the entity bean in persistent store should be set to the implementation's equivalent of default or null values.

The entity is invalid at this point. The metadata may be useful to the implementation.

This method always throws a BMPException.

Specified by:

create in interface SmartBMP

Parameters:

smartKey - the primary key of the bean

entityImpl - READ ONLY, invalid, uninitialized instance of the entity bean.

Throws:

BMPException - wrapper for provider exception

refresh

public void refresh(SmartKey smartKey,
                    EntityImpl entityImpl)
             throws BMPException

Implements BMP functionality of ejbLoad() method. Copies attributes from persistent store to the entity bean using the smartKey as primary key.

Specified by:

refresh in interface SmartBMP

Parameters:

smartKey - the primary key of the bean

entityImpl - READ/WRITE instance of the entity bean.

Throws:

BMPException - wrapper for provider exception

update

public void update(SmartKey smartKey,
                   EntityImpl entityImpl)
            throws BMPException

Implements BMP functionality of ejbStore() and ejbPostCreate() methods.

Copies attributes of entity bean to persistent store using the smartKey as primary key.

This method does nothing.

Specified by:

update in interface SmartBMP

Parameters:

smartKey - the primary key of the bean

entityImpl - READ ONLY instance of the entity bean.

Throws:

BMPException - wrapper for provider exception

remove

public void remove(SmartKey smartKey)
            throws BMPException

Implements BMP functionality of ejbRemove() method.

Remove the entity bean from persistent store using the smartKey as primary key.

This method does nothing.

Parameters:

smartKey - the primary key of the bean

Throws:

BMPException - wrapper for provider exception

remove

public void remove(SmartKey key,
                   EntityImpl impl)
            throws BMPException

Implements BMP functionality of ejbRemove() method.

Remove the entity bean from persistent store using the smartKey as primary key.

This method does nothing.

Specified by:

remove in interface SmartBMP

Parameters:

smartKey - the primary key of the bean

impl - the entity bean instance to remove.

Throws:

BMPException - wrapper for provider exception

exists

public boolean exists(SmartKey smartKey,
                      EntityImpl imp)
               throws BMPException

Indicates if a bean with the specified primary key exists in the persistent store.

Specified by:

exists in interface SmartBMP

Parameters:

smartKey - the primary key of the bean

Returns:

true if a bean with the specified primary key exists

Throws:

BMPException - wrapper for provider exception

findAll

public java.util.Enumeration findAll(EntityImpl impl)
                              throws BMPException

Implements BMP functionality of ejbFindAll() method.

Specified by:

findAll in interface SmartBMP

Parameters:

impl - an uniitialized entity bean instance to use.

Returns:

an enumeration of all instances of a type of bean.

Throws:

BMPException - wrapper for provider exception

findBySchemaGroupName

public java.util.Enumeration findBySchemaGroupName(java.lang.String groupName,
                                                   EntityImpl impl)
                                            throws BMPException

Find all the schema by a schema group name.

Since document schemas don't have group names, this returns all.

Returns:

an enumeration of all instances of a type of bean.

Throws:

BMPException - wrapper for provider exception

See Also:

findAll(com.beasys.commerce.foundation.EntityImpl)

close

public static final void close(java.sql.Statement stmt)

Helper method to close a statement, ignoring any sql exceptions.

close

public static final void close(DocumentIterator iterator)

Close a document iterator, ignoring any exceptions.

close

public final void close(java.sql.Connection con)

Helper method to close a connection, ignoring any exceptions.