org.imixs.workflow.jaxrs.v3

Class XMLItemCollectionAdapter

java.lang.Object

org.imixs.workflow.jaxrs.v3.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 org.imixs.workflow.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 EntityCollection	putCollection(Collection<org.imixs.workflow.ItemCollection> col) This method transforms a Collection into a EntityCollection
static EntityCollection	putCollection(Collection<org.imixs.workflow.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(org.imixs.workflow.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(org.imixs.workflow.ItemCollection aItemCollection, List<String> itemNames) This Method converts a org.imixs.workflow.ItemCollection into a Entity The method verifies if the values stored are basic java types.
static List<org.imixs.workflow.ItemCollection>	readCollection(byte[] byteInput) This method imports an xml entity data byte array and returns a List of ItemCollection objects.
static List<org.imixs.workflow.ItemCollection>	readCollectionFromInputStream(InputStream inputStream) This method imports an xml entity data stream and returns a List of ItemCollection objects.
static org.imixs.workflow.ItemCollection	readItemCollection(byte[] byteInput) This method imports a single XMLItemCollection and returns the ItemCollection object.
static XMLItemCollection	sortItemsByName(XMLItemCollection xmlItemCol) This method sorts all items of a XMLItemCollection by item name.

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 org.imixs.workflow.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

putItemCollection

public static XMLItemCollection putItemCollection(org.imixs.workflow.ItemCollection aItemCollection,
                                                  List<String> itemNames)
                                           throws Exception

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

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

Throws:

Exception

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(org.imixs.workflow.ItemCollection aItemCollection)
                                           throws Exception

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

Throws:

Exception

putCollection

public static EntityCollection putCollection(Collection<org.imixs.workflow.ItemCollection> col)
                                      throws Exception

This method transforms a Collection into a EntityCollection

Parameters:

col -

Returns:

Throws:

Exception

putCollection

public static EntityCollection putCollection(Collection<org.imixs.workflow.ItemCollection> col,
                                             List<String> itemNames)
                                      throws Exception

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:

Throws:

Exception

readCollectionFromInputStream

public static List<org.imixs.workflow.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

readCollection

public static List<org.imixs.workflow.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 org.imixs.workflow.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