com.beasys.commerce.axiom.document
Class SPIDocumentSmartBMP

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

public class SPIDocumentSmartBMP

extends java.lang.Object

implements SmartBMP

A DocumentImpl SmartBMP which can utilize the SPI JDBC driver to get documents and metadata.

Constructor Summary

SPIDocumentSmartBMP()

Method Summary

void	close(java.sql.Connection con) Helper method to close a connection, ignoring any exceptions.
static void	close(com.beasys.commerce.axiom.document.spi.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.
boolean	exists(SmartKey smartKey) Indicates if a bean with the specified primary key exists in the persistent store.
java.util.Enumeration	findAll() Implements BMP functionality of ejbFindAll() method.
java.util.Enumeration	findBySearchParams(Search params) Services the findBySearchParams method on the Document bean
byte[]	getContent(java.lang.String identifier, EntityImpl impl) Services the getContent method on the Document bean
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	setJNDIContext(javax.naming.Context ctx) Inform provider of ejb JNDI Context for environment.
void	update(SmartKey smartKey, EntityImpl entityImpl) Implements BMP functionality of ejbStore() and ejbPostCreate() methods.

Methods inherited from class java.lang.Object

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

Constructor Detail

SPIDocumentSmartBMP

public SPIDocumentSmartBMP()

Method Detail

setJNDIContext

public void setJNDIContext(javax.naming.Context ctx)
                    throws BMPException

Inform provider of ejb JNDI Context for environment. The implementation of this interface has have a public, default no-args constructor. The provider relies on properties in the bean's deployment descriptor as documented in a provider or Theory Center specified protocol.

Specified by:

setJNDIContext in interface SmartBMP

Parameters:

ctx - the bean's JNDI environment content

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.

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.

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.

Parameters:

smartKey - the primary key of the bean

Throws:

BMPException - wrapper for provider exception

remove

public void remove(SmartKey key,
                   EntityImpl impl)

Description copied from interface: SmartBMP

Implements BMP functionality of ejbRemove() method. Remove the entity bean from persistent store using the smartKey as primary key.

Specified by:

remove in interface SmartBMP

Tags copied from interface: SmartBMP

Parameters:

smartKey - the primary key of the bean

Throws:

BMPException - wrapper for provider exception

exists

public boolean exists(SmartKey smartKey)
               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()
                              throws BMPException

Implements BMP functionality of ejbFindAll() method.

Specified by:

findAll in interface SmartBMP

Returns:

an enumeration of all instances of a type of bean.

Throws:

BMPException - wrapper for provider exception

findBySearchParams

public java.util.Enumeration findBySearchParams(Search params)
                                         throws BMPException

Services the findBySearchParams method on the Document bean

Parameters:

params - the com.beasys.commerce.axiom.content.Search object

Returns:

Enumeration of the primary keys of the beans matching the Seacrh parameters

Throws:

BMPException - wrapper for provider exception

getContent

public byte[] getContent(java.lang.String identifier,
                         EntityImpl impl)
                  throws BMPException

Services the getContent method on the Document bean

Parameters:

identifier - the identifier (primary key) of a Document object

impl - the DocumentImpl object to execute for

Returns:

byte[] the content of a document

Throws:

BMPException - wrapper for provider exception

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(com.beasys.commerce.axiom.document.spi.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.