org.processmining.framework.log
Interface AuditTrailEntries

All Superinterfaces:
java.lang.Cloneable
All Known Implementing Classes:
AuditTrailEntriesClassic, AuditTrailEntriesProxy

Deprecated. This is only provided for backward compatibility, you should not use this class and update your implementations. Use the container interface of AuditTrailEntryList instead where possible, which should be practically everywhere!

public interface AuditTrailEntries
extends java.lang.Cloneable

This interface provides access to a sequential set of audit trail entries, as found in one process instance of a log file.

Author:
Christian W. Guenther (christian at deckfour dot org)

Method Summary
 void add(AuditTrailEntry ate)
          Deprecated. Adds an audit trail entry to the end of the list.
 void add(AuditTrailEntry ate, int pos)
          Deprecated. Adds an audit trail entry to the given position in the list.
 java.lang.Object clone()
          Deprecated. Makes a deep copy of this object.
 AuditTrailEntries cloneIteratorOnly()
          Deprecated. Makes a shallow copy of this object.
 AuditTrailEntry first()
          Deprecated. Gets the first element out of the list of audit trail entries.
 AuditTrailEntry getEntry(int n)
          Deprecated. Retrieves an audit trail entry based on the given position in the list.
 boolean hasNext()
          Deprecated. Iterator-style access method.
 AuditTrailEntry last()
          Deprecated. Gets the last element out of the list of audit trail entries.
 AuditTrailEntry next()
          Deprecated. Iterator-style access method.
 void remove()
          Deprecated. Iterator-style access method.
 void reset()
          Deprecated. Iterator-style access method.
 int size()
          Deprecated. Determines the number of audit trail entries stored in the list.
 java.util.ArrayList toArrayList()
          Deprecated. Use the random access interface (e.g. get(index)) instead, as this method is subject to proximate deletion!
 java.lang.String toString()
          Deprecated. Retrieves the list of audit trail entries as a string.
 

Method Detail

hasNext

boolean hasNext()
Deprecated. 
Iterator-style access method.

Determines whether there is another audit trail entry left. (This relates to the built-in iterator walking through the elements.)

Returns:
true if there is at least one audit trail entry left, false otherwise.
See Also:
next

next

AuditTrailEntry next()
Deprecated. 
Iterator-style access method.

Retrieves the next audit trail entry from the list. (This relates to the built-in iterator walking through the elements and implies moving it one poksition further.) Before calling this method one should call hasNext in order to determine whether there is onother element left.

Returns:
the next AuditTrailEntry from the list

reset

void reset()
Deprecated. 
Iterator-style access method.

Resets the built-in iterator to the first element of the list.


remove

void remove()
Deprecated. 
Iterator-style access method.

Remove the entry that was returned by the last call to next().


add

void add(AuditTrailEntry ate)
Deprecated. 
Adds an audit trail entry to the end of the list.

Parameters:
ate - the entry to add

add

void add(AuditTrailEntry ate,
         int pos)
Deprecated. 
Adds an audit trail entry to the given position in the list.

Parameters:
ate - the entry to add
pos - the position of the entry

toArrayList

java.util.ArrayList toArrayList()
Deprecated. Use the random access interface (e.g. get(index)) instead, as this method is subject to proximate deletion!

Returns the list of audit trail entries.

WARNING: The usage contract for this interface determines, that any changes that you make for the returned array list will not be persistent to both this instance and the potentially wrapped higher-level classes! Use dedicated modification methods for this purpose!

Returns:
the list of audit trail entries as an ArrayList

first

AuditTrailEntry first()
Deprecated. 
Gets the first element out of the list of audit trail entries.

Returns:
the first AuditTrailEntry from the list

last

AuditTrailEntry last()
Deprecated. 
Gets the last element out of the list of audit trail entries.

Returns:
the last AuditTrailEntry from the list

getEntry

AuditTrailEntry getEntry(int n)
Deprecated. 
Retrieves an audit trail entry based on the given position in the list.

Parameters:
n - the index position in the list (starting with 0)
Returns:
the AuditTrailEntry stored at the given position

toString

java.lang.String toString()
Deprecated. 
Retrieves the list of audit trail entries as a string.

Overrides:
toString in class java.lang.Object
Returns:
all entries as a String

size

int size()
Deprecated. 
Determines the number of audit trail entries stored in the list.

Returns:
the number of audit trail entries

cloneIteratorOnly

AuditTrailEntries cloneIteratorOnly()
Deprecated. 
Makes a shallow copy of this object. This means that the contained list of AuditTrailEntry elements will be not cloned. However, the iterator is duplicated in its current positon.

Returns:
the cloned object

clone

java.lang.Object clone()
Deprecated. 
Makes a deep copy of this object. This means that both the contained list of AuditTrailEntry elements and the iterator in its current positon will be duplicated. Overrides clone.

Returns:
the cloned object