cz.ues.platform.sysc.data

Class SyscDataBuffer<T>

java.lang.Object

cz.ues.platform.sysc.data.SyscDataBuffer<T>

Type Parameters:

T - Type of system catalog object

@UESComponent
@Prototype
public abstract class SyscDataBuffer<T>
extends java.lang.Object

Component used for buffering and sorting of system catalog objects in order to be able to process them in correct order (based on their dependencies and references). Component also helps to detect cyclic and missing relations before processing of data.

Since:

UES7-00

Field Summary

Fields

Modifier and Type	Field and Description
private UESLogger	progressLog Instance of progress log.
private java.util.List<T>	sortedObjects List of sorted objects.

Constructor Summary

Constructors

Constructor and Description
SyscDataBuffer()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract boolean	dependsOn(T dependant, T superior) Checks if one system catalog object is dependent on other system catalog object of same type.
protected abstract boolean	equals(T objectA, T objectB) Checks if system catalog objects are equal (typically compared by ID or code).
void	flush() Processes all added objects in order depending on their relations.
protected UESLogger	getProgressLog() Returns logger for optional progress monitoring.
protected void	handleCyclicalRelation(T addedObject, T dependant, T superior) Handles cyclic relation between added objects.
protected T	handleDuplicateObject(T addedObject, T objectDuplicate) Handles duplicate object.
protected abstract void	process(T object) Method used for processing of system catalog object.
T	put(T object) Adds object to buffer.
int	size() Returns actual size of buffered data.

Methods inherited from class java.lang.Object

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

Field Detail

sortedObjects

private sortedObjects

List of sorted objects.

progressLog

@Named(value="cz.ues.platform.sysc.data.SyscDataBuffer")

private progressLog

Instance of progress log.

Constructor Detail

SyscDataBuffer

public SyscDataBuffer()

Method Detail

put

public T put(T object)

Adds object to buffer.

Parameters:

object - Object to be added

Returns:

Actually added object (Depending on implementation it may be result of merging existing object with given one)

Since:

UES7-00

flush

public void flush()

Processes all added objects in order depending on their relations. After processing of all objects, buffer is cleared.

Since:

UES7-00

size

public int size()

Returns actual size of buffered data.

Returns:

Actual size

Since:

UES7-00

getProgressLog

protected UESLogger getProgressLog()

Returns logger for optional progress monitoring.

Returns:

UES Logger

Since:

UES7-00

handleCyclicalRelation

protected void handleCyclicalRelation(T addedObject,
T dependant,
T superior)

Handles cyclic relation between added objects. Default implementation throws exception.

Parameters:

addedObject - Object being added

dependant - Object which is dependent on added object

superior - Object which is superior to added object

Since:

UES7-00

handleDuplicateObject

protected T handleDuplicateObject(T addedObject,
T objectDuplicate)

Handles duplicate object. Default implementation throws exception. Method may be overridden to change this behavior, either to replace duplicate object or to keep existing.

Parameters:

addedObject - Object being added

objectDuplicate - Already added duplicate object

Returns:

Object to be used as replacement for already added duplicate object, null if already added object should be kept

Since:

UES7-00

dependsOn

protected abstract boolean dependsOn(T dependant,
T superior)

Checks if one system catalog object is dependent on other system catalog object of same type. Returns true if object is dependent, false if either both objects has no relation or relation is in opposite direction than order of given parameters.

Parameters:

dependant - Object which dependency is checked

superior - Object evaluated as superior of checked object

Returns:

True if dependant depends on superior object

Since:

UES7-00

equals

protected abstract boolean equals(T objectA,
T objectB)

Checks if system catalog objects are equal (typically compared by ID or code).

Parameters:

objectA - First object to be compared

objectB - Second object to be compared

Returns:

True if objects are equal

Since:

UES7-00

process

protected abstract void process(T object)

Method used for processing of system catalog object. This method is invoked for each buffered object after invocation of SyscDataBuffer.flush() method. All buffered object are processed in order so that superior objects are processed before their depentants.

Parameters:

object - System catalog object to be processed

Since:

UES7-00