Package com.priint.pubserver.comet.bridge

Interface Comet3Collection<T extends Comet3Entity>

Type Parameters:

T - the type parameter

All Superinterfaces:

java.util.Collection<T>, java.lang.Iterable<T>, java.util.List<T>

All Known Implementing Classes:

Actions, Colors, Comet3CollectionImpl, ConditionMenues, Conditions, DataFiles, Domains, FindStatement.Sourcefiles, FindStatements, FrameRules, Grid.Placeholders, Grids, GridTypes, Manifest, Messages, PageItems, PageItemStates, PageItemTypes, PageTemplate.Templates, PageTemplates, PanelStatements, PlaceholderGroup.Placeholders, PlaceholderGroups, Placeholders, PlaceholderVariants, PreviewStatements, RelatedTos, XEntities, XIndexes

public interface Comet3Collection<T extends Comet3Entity>
extends java.util.List<T>

The interface Comet 3 collection. For internal use only.

Method Summary

Modifier and Type	Method	Description
T	findById(int id)	Lookup the Entity refered by id in this collection.
java.lang.Long	getLastModificationTimestamp()	Get the time (unix timestamp) the collection was modified last
java.lang.String	getXmlFileName()	Get the name of the XML file associated with this particular collection.
java.lang.String	getXmlRootElementName()	Get the name of the XML root element.
Comet3Collection<T>	merge(Comet3Collection<T> other)	Merge collection other into the actual collection.
Comet3Collection<T>	merge(Comet3Collection<T> other, boolean deleteObj)	Merge collection other into the actual collection.
void	merge(T item)	Merge an item into the actual list.
void	setLastModificationTimestamp(java.lang.Long timestamp)	Set the time the collection was modified last

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Method Detail

getLastModificationTimestamp

java.lang.Long getLastModificationTimestamp()

Get the time (unix timestamp) the collection was modified last

Returns:

unix timestamp of last modification date

setLastModificationTimestamp

void setLastModificationTimestamp(java.lang.Long timestamp)

Set the time the collection was modified last

Parameters:

timestamp - the timestamp

merge

Comet3Collection<T> merge(Comet3Collection<T> other)

Merge collection other into the actual collection. Entries will be compared by ID, i.e.: equal IDs will be considered as equal objects. Newer objects take precedence over older, if both have the same modification date objects in collection other take precedence over objects in the actual collection.

Parameters:

other - the other

Returns:

a newly created collection containing the most recent entities of both lists

merge

Comet3Collection<T> merge(Comet3Collection<T> other,
                          boolean deleteObj)

Merge collection other into the actual collection. Entries will be compared by ID, i.e.: equal IDs will be considered as equal objects. Newer objects take precedence over older, if both have the same modification date objects in collection other take precedence over objects in the actual collection. If deleteObj is set to true, objects not contained in collection other will be deleted from the actual collection.

Parameters:

other - the other

deleteObj - the delete obj

Returns:

a newly created collection containing the most recent entities of both lists

merge

void merge(T item)

Merge an item into the actual list. If this item does not yet exist (i.e.: there is no such object with the same Id), the item will be added, otherwise items will be merged according to the merge rules for this particular entity type.

Parameters:

item - the item

findById

T findById(int id)

Lookup the Entity refered by id in this collection.

Parameters:

id - the id

Returns:

Entity object or null, if no such object exists

getXmlRootElementName

java.lang.String getXmlRootElementName()

Get the name of the XML root element. Typically this is getClass().getSimpleName().toLowerCase() and is implemented in the CometCollectionImpl adapter class.

Returns:

name of the XML root element

getXmlFileName

java.lang.String getXmlFileName()

Get the name of the XML file associated with this particular collection. Typically this is getClass().getSimpleName().toLowerCase() + ".xml" and is implemented in the CometCollectionImpl adapter class

Returns:

name of a XML file holding this particular list