org.apache.jackrabbit.ocm.manager.collectionconverter
Interface CollectionConverter

All Known Implementing Classes:

AbstractCollectionConverterImpl, BeanReferenceCollectionConverterImpl, DefaultCollectionConverterImpl, MultiValueCollectionConverterImpl, NTCollectionConverterImpl, ReferenceCollectionConverterImpl, ResidualNodesCollectionConverterImpl, ResidualPropertiesCollectionConverterImpl

public interface CollectionConverter

Convert any kind of ManageableCollection into severals JCR nodes.

Author:

Lombart Christophe

Method Summary

ManageableCollection	getCollection(Session session, Node parentNode, CollectionDescriptor collectionDescriptor, Class collectionFieldClass) Get a ManageableCollection from the JCR repository
void	insertCollection(Session session, Node parentNode, CollectionDescriptor collectionDescriptor, ManageableCollection collection) Insert/convert collection elements into some JCR nodes
boolean	isNull(Session session, Node parentNode, CollectionDescriptor collectionDescriptor, Class collectionFieldClass) Check if the collection is null.
void	updateCollection(Session session, Node parentNode, CollectionDescriptor collectionDescriptor, ManageableCollection collection) Update collection elements already present in the JCR repository

Method Detail

insertCollection

void insertCollection(Session session,
                      Node parentNode,
                      CollectionDescriptor collectionDescriptor,
                      ManageableCollection collection)
                      throws ObjectContentManagerException

Insert/convert collection elements into some JCR nodes

Parameters:

session - The JCR session

parentNode - the node which will contains the collection element

collectionDescriptor - The collection descriptor

collection - the collection to insert

Throws:

ObjectContentManagerException - when it is not possible to insert the collection

updateCollection

void updateCollection(Session session,
                      Node parentNode,
                      CollectionDescriptor collectionDescriptor,
                      ManageableCollection collection)
                      throws ObjectContentManagerException

Update collection elements already present in the JCR repository

Parameters:

session - The JCR session

parentNode - the node which will contains the collection element

collectionDescriptor - The collection descriptor

collection - the collection to update

Throws:

ObjectContentManagerException - when it is not possible to update the collection

getCollection

ManageableCollection getCollection(Session session,
                                   Node parentNode,
                                   CollectionDescriptor collectionDescriptor,
                                   Class collectionFieldClass)
                                   throws ObjectContentManagerException

Get a ManageableCollection from the JCR repository

Parameters:

session - The JCR session

parentNode - the node which contains the collection element

collectionDescriptor - The collection descriptor

collectionFieldClass - The collection class to used (ArrayList, Vector, ..)

Returns:

The collection populates with all elements found in the JCR repository

Throws:

ObjectContentManagerException - when it is not possible to retrieve the collection

isNull

boolean isNull(Session session,
               Node parentNode,
               CollectionDescriptor collectionDescriptor,
               Class collectionFieldClass)
               throws ObjectContentManagerException

Check if the collection is null. This method is mainly used in the Proxy manager to return a null value or a proxy object Without proxy proxy, this method is never called.

Parameters:

session - The JCR session

parentNode - the node which contains the collection element

collectionDescriptor - The collection descriptor

collectionFieldClass - The collection class to used (ArrayList, Vector, ..)

Returns:

true if the collection contains elements.

Throws:

ObjectContentManagerException - when it is not possible to retrieve the collection