HistoryRecord (ChargerLib)

Object
- chargerlib.history.HistoryRecord

Direct Known Subclasses:

CustomHistoryRecord, DerivedHistoryRecord, ObjectHistoryRecord
```
public abstract class HistoryRecord
extends Object
```
An abstraction of some event in the history of some object. Keeps a timestamp, description, and an object (possibly null). The type is a string that sub-classes and parsers may define. Sub-classes must provide a zero-argument constructor in order if they want to be fully supported when copying a complete history.

See Also:

ObjectHistory.duplicateHistory()

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`description` A free-form text description.
`static String`	`GenericHistoryRecordType`
`protected Object`	`object` An object that's associated with this event.
`protected CDateTime`	`timestamp` When this event was first created; should be preserved through copies, saving, etc.
`protected String`	`type` What type event is this -- Charger reserves a few for itself.

Constructor Summary

Constructors
Constructor and Description

HistoryRecord()

Constructors
Constructor and Description
`HistoryRecord()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendDescription(String description)` Uses newline as a separator by default.
`void`	`appendDescription(String description, String separator)` Append a new portion to the description, separated by the separator.
`void`	`copyInfoFrom(HistoryRecord he)` Copy this event's information from the event argument.
`String`	`getDescription()` Get an explanatory note for this event.
`Object`	`getObject()`
`CDateTime`	`getTimestamp()` Get the date/time that this event occurred.
`String`	`getType()` The string identifier for the type of this history event.
`org.w3c.dom.Document`	`makeDocument()` Return the history event DOM tree node for the bare history event.
`void`	`setDescription(String description)`
`void`	`setObject(Object object)`
`void`	`setTimestamp(CDateTime timestamp)` Set the date and time that this event occurred.
`void`	`setType(String type)`
`String`	`toString()`
`String`	`toXML()` Create an event tag in XML for this history event.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - GenericHistoryRecordType
```
public static String GenericHistoryRecordType
```
  - timestamp
```
protected CDateTime timestamp
```
    When this event was first created; should be preserved through copies, saving, etc.
  - description
```
protected String description
```
    A free-form text description.
  - type
```
protected String type
```
    What type event is this -- Charger reserves a few for itself. Other modules and applications should use "CUSTOM" as their type and provide their own additional XML elements as they are needed.
  - object
```
protected Object object
```
    An object that's associated with this event. In a sense, it's redundant, since history events are already associated with an object, but there may be cases where this is relevant.
- Constructor Detail
  - HistoryRecord
```
public HistoryRecord()
```
- Method Detail
  - copyInfoFrom
```
public void copyInfoFrom(HistoryRecord he)
```
    Copy this event's information from the event argument. Subclasses are responsible for copying their own information after calling this method. Doesn't have the deep responsibility of a true clone;
    
    Parameters:
    
    he - the event to receive the values from this event.
  - getTimestamp
```
public CDateTime getTimestamp()
```
    Get the date/time that this event occurred.
  - setTimestamp
```
public void setTimestamp(CDateTime timestamp)
```
    Set the date and time that this event occurred.
  - getDescription
```
public String getDescription()
```
    Get an explanatory note for this event.
    
    Returns:
    
    If the description is null or empty, return the empty string.
  - appendDescription
```
public void appendDescription(String description,
                              String separator)
```
    Append a new portion to the description, separated by the separator. If the description is still empty, then omit the separator.
    
    Parameters:
    
    description -
    
    separator - either a newline or some xml separator.
  - appendDescription
```
public void appendDescription(String description)
```
    Uses newline as a separator by default.
    
    Parameters:
    
    description -
  - setDescription
```
public void setDescription(String description)
```
  - getType
```
public String getType()
```
    The string identifier for the type of this history event.
  - setType
```
public void setType(String type)
```
  - getObject
```
public Object getObject()
```
  - setObject
```
public void setObject(Object object)
```
  - makeDocument
```
public org.w3c.dom.Document makeDocument()
```
    Return the history event DOM tree node for the bare history event. It is wrapped in a Document for convenience. Use getDocumentElement() to extract as the top-level element. Will be used by subclasses to create the tag so they can add things to it.
    
    Returns:
    
    a DOM document tree for the event.
  - toXML
```
public String toXML()
```
    Create an event tag in XML for this history event.
    
    Parameters:
    
    indent - prepend this to every line.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class HistoryRecord

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

GenericHistoryRecordType

timestamp

description

type

object

Constructor Detail

HistoryRecord

Method Detail

copyInfoFrom

getTimestamp

setTimestamp

getDescription

appendDescription

appendDescription

setDescription

getType

setType

getObject

setObject

makeDocument

toXML

toString