com.arcway.cockpit.docgen.provider.interfaces

Interface IArrayHelper

public interface IArrayHelper

The IArrayHelper provides access methods used for handling arrays for document generation. The IArrayHelper can be referenced directly within a document template by its name arrayHelper.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Object>	appendToArray(java.util.List<java.lang.Object> array, java.lang.Object o) Deprecated. use Collection#add()
java.util.List<java.lang.Object>	appendToArray(java.lang.Object[] array, java.lang.Object o) Deprecated. use Collection#add()
java.util.List<java.lang.Object>	appendToArray(java.lang.String[] array, java.lang.Object o) Deprecated. use Collection#add()
boolean	arrayIsEmpty(java.util.List<java.lang.Object> array) Deprecated. use Collection.isEmpty()
boolean	arrayIsEmpty(java.lang.Object[] array) Deprecated. use Collection.isEmpty()
boolean	arrayIsEmpty(java.lang.String[] array) Deprecated. use Collection.isEmpty()
java.util.List<java.lang.Object>	convertToList(java.util.List<java.lang.Object> array) Deprecated.
java.util.List<java.lang.Object>	convertToList(java.lang.Object[] array) Deprecated. velocity can handle object arrays as object lists
java.util.List<java.lang.String>	convertToList(java.lang.String[] array) Deprecated. string array are not used anymore
java.util.Map<?,?>	createHashMap() Creates an empty hash map object.
java.util.Set<?>	createHashSet() Creates an empty hash set object.
java.util.List<?>	createList() Creates an empty array list object.
com.arcway.lib.codec.xml.XMLProcessingInstruction	createProcessingInstruction(java.lang.String target, java.lang.String data) XML Processing instruction as used in IRecords that represent XML files.
IRecord	createRecord() Creates a record.
java.util.SortedSet<IRecord>	createRecordSortedSet(java.util.List<java.lang.String> propertyIDsForSorting) Creates a set in which records are sorted in the order of the given property IDs.
java.util.SortedMap<?,?>	createSortedMap() Creates an empty tree map object.
java.util.SortedSet<?>	createSortedSet() Creates an empty tree set object.
int	getArraySize(java.util.List<java.lang.Object> array) Deprecated. use Collection.size()
int	getArraySize(java.lang.Object[] array) Deprecated. use Collection.size()
int	getArraySize(java.lang.String[] array) Deprecated. use Collection.size()
IRecord	getCachedRecord(java.util.Map<java.lang.String,IRecord> uid2cachedRecord, ICockpitData cockpitData) Converts a cockpit project data into a record.
IRecord	getCachedRecordCrossProject(java.util.Map<java.lang.String,java.util.Map<java.lang.String,IRecord>> projectUID2uid2cachedRecord, ICockpitData cockpitData, java.util.Set<java.lang.String> keyWhiteList) Converts a cockpit project data into a record.
java.util.List<IRecord>	getCachedRecords(java.util.Map<java.lang.String,IRecord> uid2cachedRecord, java.util.Collection<ICockpitData> cockpitDatas) Converts cockpit project data into records.
java.util.List<IRecord>	getCachedRecordsCrossProject(java.util.Map<java.lang.String,java.util.Map<java.lang.String,IRecord>> projectUID2uid2cachedRecord, java.util.Collection<ICockpitData> cockpitDatas, java.util.Set<java.lang.String> keyWhiteList) Converts cockpit project data into records.
java.util.SortedSet<IRecord>	sortRecords(java.util.Collection<IRecord> records, java.util.List<java.lang.String> propertyIDsForSorting) Sorts the given records in the order of the given property IDs.

Method Detail

arrayIsEmpty

@Deprecated
boolean arrayIsEmpty(java.lang.Object[] array)

Deprecated. use Collection.isEmpty()

Checks whether the given array is empty.

Parameters:

array - The array that will be checked

Returns:

true: the given array is empty or NULL

getArraySize

@Deprecated
int getArraySize(java.lang.Object[] array)

Deprecated. use Collection.size()

Returns the size of the array.

Parameters:

array -

Returns:

size of the array (0 if array is NULL)

arrayIsEmpty

@Deprecated
boolean arrayIsEmpty(java.lang.String[] array)

Deprecated. use Collection.isEmpty()

Checks whether the given array is empty.

Parameters:

array - The array that will be checked

Returns:

true: the given array is empty or NULL

getArraySize

@Deprecated
int getArraySize(java.lang.String[] array)

Deprecated. use Collection.size()

Returns the size of the array.

Parameters:

array -

Returns:

size of the array (0 if array is NULL)

appendToArray

@Deprecated
java.util.List<java.lang.Object> appendToArray(java.lang.Object[] array,
                                                           java.lang.Object o)

Deprecated. use Collection#add()

Creates a new array which contains the data of the specified array and the specified object as last element. In the case that the given array is null, a new array is created.

Parameters:

array - array with first elements for new array, may be null

o - object to add as last element to the new array

Returns:

new array containing the elements of the given array plus the given object as last element

appendToArray

@Deprecated
java.util.List<java.lang.Object> appendToArray(java.lang.String[] array,
                                                           java.lang.Object o)

Deprecated. use Collection#add()

Creates a new array which contains the data of the specified array and the specified object as last element. In the case that the given array is null, a new array is created.

Parameters:

array - array with first elements for new array, may be null

o - object to add as last element to the new array

Returns:

new array containing the elements of the given array plus the given object as last element

convertToList

@Deprecated
java.util.List<java.lang.Object> convertToList(java.lang.Object[] array)

Deprecated. velocity can handle object arrays as object lists

Converts the given array into a List.

Parameters:

array - aray to convert

Returns:

List object

convertToList

@Deprecated
java.util.List<java.lang.String> convertToList(java.lang.String[] array)

Deprecated. string array are not used anymore

Converts the given array into a List.

Parameters:

array - aray to convert

Returns:

List object

arrayIsEmpty

@Deprecated
boolean arrayIsEmpty(java.util.List<java.lang.Object> array)

Deprecated. use Collection.isEmpty()

Checks whether the given array is empty.

Parameters:

array - The array that will be checked

Returns:

true: the given array is empty or NULL

getArraySize

@Deprecated
int getArraySize(java.util.List<java.lang.Object> array)

Deprecated. use Collection.size()

Returns the size of the array.

Parameters:

array -

Returns:

size of the array (0 if array is NULL)

appendToArray

@Deprecated
java.util.List<java.lang.Object> appendToArray(java.util.List<java.lang.Object> array,
                                                           java.lang.Object o)

Deprecated. use Collection#add()

Creates a new array which contains the data of the specified array and the specified object as last element. In the case that the given array is null, a new array is created.

Parameters:

array - array with first elements for new array, may be null

o - object to add as last element to the new array

Returns:

new array containing the elements of the given array plus the given object as last element

convertToList

@Deprecated
java.util.List<java.lang.Object> convertToList(java.util.List<java.lang.Object> array)

Deprecated.

Converts the given array into a List.

Parameters:

array - aray to convert

Returns:

List object

createList

java.util.List<?> createList()

Creates an empty array list object.

Returns:

created list

createHashSet

java.util.Set<?> createHashSet()

Creates an empty hash set object.

Returns:

created set

createSortedSet

java.util.SortedSet<?> createSortedSet()

Creates an empty tree set object.

Returns:

created set

createSortedMap

java.util.SortedMap<?,?> createSortedMap()

Creates an empty tree map object.

Returns:

created map

createHashMap

java.util.Map<?,?> createHashMap()

Creates an empty hash map object.

Returns:

created map

createRecord

IRecord createRecord()

Creates a record.

See IRecord.

Returns:

a newly created record (never null)

getCachedRecord

IRecord getCachedRecord(java.util.Map<java.lang.String,IRecord> uid2cachedRecord,
                        ICockpitData cockpitData)

Converts a cockpit project data into a record.

Records are cached, i.e. if a record previously was created for an equivalent project data, the formerly created record is returned.

The records are created corresponding to ICockpitData.toRecord().

Parameters:

uid2cachedRecord - a map with the object's UID as string and the record as value

cockpitData - the cockpit data to be converted

Returns:

converted cockpit project data

getCachedRecords

java.util.List<IRecord> getCachedRecords(java.util.Map<java.lang.String,IRecord> uid2cachedRecord,
                                         java.util.Collection<ICockpitData> cockpitDatas)

Converts cockpit project data into records.

Records are cached, i.e. if a record previously was created for an equivalent project data, the formerly created record is returned. The created records are sortable (and sorted) in the order of the given property IDs.

The records are created corresponding to ICockpitData.toRecord().

Parameters:

uid2cachedRecord - a map with the object's UID as string and the record as value

cockpitData - the cockpit data to be converted

Returns:

all converted cockpit project data

getCachedRecordCrossProject

IRecord getCachedRecordCrossProject(java.util.Map<java.lang.String,java.util.Map<java.lang.String,IRecord>> projectUID2uid2cachedRecord,
                                    ICockpitData cockpitData,
                                    java.util.Set<java.lang.String> keyWhiteList)

Converts a cockpit project data into a record.

Records are cached, i.e. if a record previously was created for an equivalent project data, the formerly created record is returned.

The records are created corresponding to ICockpitData.toRecord().

Parameters:

uid2cachedRecord - a map with the project UID as key and as value a map with the object's UID as string and the record as value

cockpitData - the cockpit data to be converted

keyWhiteList - only properties are filled into the record of which the keys are contained in keyWhiteList (empty to include no property, null to include all properities)

Returns:

converted cockpit project data

getCachedRecordsCrossProject

java.util.List<IRecord> getCachedRecordsCrossProject(java.util.Map<java.lang.String,java.util.Map<java.lang.String,IRecord>> projectUID2uid2cachedRecord,
                                                     java.util.Collection<ICockpitData> cockpitDatas,
                                                     java.util.Set<java.lang.String> keyWhiteList)

Converts cockpit project data into records.

Records are cached, i.e. if a record previously was created for an equivalent project data, the formerly created record is returned. The created records are sortable (and sorted) in the order of the given property IDs.

The records are created corresponding to ICockpitData.toRecord().

Parameters:

uid2cachedRecord - a map with the project UID as key and as value a map with the object's UID as string and the record as value

cockpitData - the cockpit data to be converted

keyWhiteList - only properties are filled into the record of which the keys are contained in keyWhiteList (empty to include no property, null to include all properities)

Returns:

all converted cockpit project data

createRecordSortedSet

java.util.SortedSet<IRecord> createRecordSortedSet(java.util.List<java.lang.String> propertyIDsForSorting)

Creates a set in which records are sorted in the order of the given property IDs.

Returns:

sorted set

sortRecords

java.util.SortedSet<IRecord> sortRecords(java.util.Collection<IRecord> records,
                                         java.util.List<java.lang.String> propertyIDsForSorting)

Sorts the given records in the order of the given property IDs.

Returns:

sorted records

createProcessingInstruction

com.arcway.lib.codec.xml.XMLProcessingInstruction createProcessingInstruction(java.lang.String target,
                                                                              java.lang.String data)

XML Processing instruction as used in IRecords that represent XML files.

Parameters:

target -

data -

Returns:

xml processing instruction