org.imixs.workflow.xml

Class XMLItemCollectionAdapter

java.lang.Object

org.imixs.workflow.xml.XMLItemCollectionAdapter

public class XMLItemCollectionAdapter
extends Object

An XMLItemCollectionAdapter converts a org.imixs.workflow.xml.XMLItemCollection into a org.imixs.workflow.ItemCollection and reverse

Version:

1.1

Author:

imixs.com - Ralph Soika

See Also:

ItemCollection

Constructor Summary

Constructors

Constructor and Description
XMLItemCollectionAdapter()

Method Summary

Modifier and Type	Method and Description
static List<ItemCollection>	getCollection(DocumentCollection doccol) This Method converts a org.imixs.workflow.xml.DocumentCollection into a List of org.imixs.workflow.ItemCollection The method returns an empty list if the collection is empty or null
static ItemCollection	getItemCollection(XMLItemCollection entity) This Method converts a org.imixs.workflow.xml.XMLItemCollection into a org.imixs.workflow.ItemCollection Returns null if entity == null
static DocumentCollection	putCollection(Collection<ItemCollection> col) This method transforms a Collection into a EntityCollection
static DocumentCollection	putCollection(Collection<ItemCollection> col, List<String> itemNames) This method transforms a Collection into a EntityCollection If the attribute List is provided only the corresponding properties will be returned.
static XMLItemCollection	putItemCollection(ItemCollection aItemCollection) This Method converts a org.imixs.workflow.ItemCollection into a Entity The method verifies if the values stored are basic java types.
static XMLItemCollection	putItemCollection(ItemCollection sourceItemCollection, List<String> itemNames) This Method converts a org.imixs.workflow.ItemCollection into a XMLItemCollection The method verifies if the values stored are basic java types.
static List<ItemCollection>	readCollection(byte[] byteInput) This method imports an xml entity data byte array and returns a List of ItemCollection objects.
static List<ItemCollection>	readCollectionFromInputStream(InputStream inputStream) This method imports an xml entity data stream and returns a List of ItemCollection objects.
static ItemCollection	readItemCollection(byte[] byteInput) This method imports a single XMLItemCollection and returns the ItemCollection object.
static ItemCollection	readItemCollectionFromInputStream(InputStream inputStream) This method imports an xml entity data stream containing a singel document and returns the ItemCollection.
static XMLItemCollection	sortItemsByName(XMLItemCollection xmlItemCol) This method sorts all items of a XMLItemCollection by item name.
static byte[]	writeItemCollection(ItemCollection document) This method writes a ItemCollection into a Byte array

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLItemCollectionAdapter

public XMLItemCollectionAdapter()

Method Detail

getItemCollection

public static ItemCollection getItemCollection(XMLItemCollection entity)

This Method converts a org.imixs.workflow.xml.XMLItemCollection into a org.imixs.workflow.ItemCollection Returns null if entity == null

Parameters:

entity -

Returns:

ItemCollection

getCollection

public static List<ItemCollection> getCollection(DocumentCollection doccol)

This Method converts a org.imixs.workflow.xml.DocumentCollection into a List of org.imixs.workflow.ItemCollection The method returns an empty list if the collection is empty or null

Parameters:

entity -

Returns:

ItemCollection

putItemCollection

public static XMLItemCollection putItemCollection(ItemCollection sourceItemCollection,
                                                  List<String> itemNames)

This Method converts a org.imixs.workflow.ItemCollection into a XMLItemCollection

The method verifies if the values stored are basic java types. If not these values will not be converted!

Parameters:

sourceItemCollection - ItemCollection Object to be converted

itemNames - - optional list of item names to be converted. If null all items will be converted

sortItemsByName

public static XMLItemCollection sortItemsByName(XMLItemCollection xmlItemCol)

This method sorts all items of a XMLItemCollection by item name.

Parameters:

xmlItemCol -

Returns:

putItemCollection

public static XMLItemCollection putItemCollection(ItemCollection aItemCollection)

This Method converts a org.imixs.workflow.ItemCollection into a Entity

The method verifies if the values stored are basic java types. If not these values will not be converted!

Parameters:

aItemCollection - Collection Object to be converted

putCollection

public static DocumentCollection putCollection(Collection<ItemCollection> col)

This method transforms a Collection into a EntityCollection

Parameters:

col -

Returns:

putCollection

public static DocumentCollection putCollection(Collection<ItemCollection> col,
                                               List<String> itemNames)

This method transforms a Collection into a EntityCollection If the attribute List is provided only the corresponding properties will be returned.

Parameters:

col - - collection of ItemCollection objects to be converted

itemNames - - optional list of item names to be converted. If null all items will be converted

Returns:

readCollectionFromInputStream

public static List<ItemCollection> readCollectionFromInputStream(InputStream inputStream)
                                                          throws JAXBException,
                                                                 IOException

This method imports an xml entity data stream and returns a List of ItemCollection objects. The method can import any kind of entity data like model or configuration data an xml export of workitems.

Parameters:

inputStream - xml input stream

Returns:

List of ItemCollection objects

Throws:

JAXBException

IOException

readItemCollectionFromInputStream

public static ItemCollection readItemCollectionFromInputStream(InputStream inputStream)
                                                        throws JAXBException,
                                                               IOException

This method imports an xml entity data stream containing a singel document and returns the ItemCollection.

Parameters:

inputStream - xml input stream

Returns:

List of ItemCollection objects

Throws:

JAXBException

IOException

readCollection

public static List<ItemCollection> readCollection(byte[] byteInput)
                                           throws JAXBException,
                                                  IOException

This method imports an xml entity data byte array and returns a List of ItemCollection objects. The method can import any kind of entity data like model or configuration data an xml export of workitems.

Parameters:

inputStream - xml input stream

Returns:

List of ItemCollection objects

Throws:

JAXBException

IOException

readItemCollection

public static ItemCollection readItemCollection(byte[] byteInput)
                                         throws JAXBException,
                                                IOException

This method imports a single XMLItemCollection and returns the ItemCollection object.

Parameters:

inputStream - xml input stream

Returns:

List of ItemCollection objects

Throws:

JAXBException

IOException

writeItemCollection

public static byte[] writeItemCollection(ItemCollection document)
                                  throws JAXBException,
                                         IOException

This method writes a ItemCollection into a Byte array

Parameters:

inputStream - xml input stream

Returns:

List of ItemCollection objects

Throws:

JAXBException

IOException