ro.sync.ecss.changetracking
Class ChangeMarker

java.lang.Object
  ro.sync.ecss.changetracking.ChangeMarker

All Implemented Interfaces:

Comparable<ChangeMarker>, ChangeConstants

public abstract class ChangeMarker
extends Object
implements Comparable<ChangeMarker>, ChangeConstants

Change marker base class.

Field Summary

Fields inherited from interface ro.sync.ecss.changetracking.ChangeConstants

ALL_MARKERS_PI, AUTHOR_NAME_ATTRIBUTE, COMMENT_ATTRIBUTE, COMMENT_CHANGE, COMMENT_CHANGE_MARKER_PI, COMMENT_CHANGE_PI_END, COMMENT_CHANGE_PI_START, CONTENT, DELETE_CHANGE, DELETE_CHANGE_MARKER_PI, DELETE_CHANGE_PI, END_ATTRIBUTE, INSERT_CHANGE, INSERT_CHANGE_MARKER_PI, INSERT_CHANGE_PI_END, INSERT_CHANGE_PI_START, MODIFICATION_TIME, START_ATTRIBUTE

Constructor Summary

ChangeMarker()

Method Summary

int	compareTo(ChangeMarker o) It compares the start offset of the current change marker with the start offset of the other one.
boolean	containsOffset(int offset) Returns true if the given offset is located between the start and end offsets of the current change marker.
String	getAuthor()
String	getAuthorComment()
int	getChangeType()
String	getDescription() Get the change marker description.
abstract int	getEndOffset()
String	getModificationTime()
abstract int	getStartOffset()
void	setAuthor(String author) Sets the author of the change.
void	setAuthorComment(String authorComment)
void	setModTime(String modTime) Sets the time stamp of the change.
void	setType(int type) Sets the change type.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeMarker

public ChangeMarker()

Method Detail

setType

public void setType(int type)

Sets the change type.

Parameters:

type - The change type to set. For example ChangeConstants.INSERT_CHANGE.

getAuthor

public final String getAuthor()

Returns:

Returns the author of the change.

setAuthor

public void setAuthor(String author)

Sets the author of the change.

Parameters:

author - The author of the change to set.

setModTime

public void setModTime(String modTime)

Sets the time stamp of the change.

Parameters:

modTime - The modification time to set.

getModificationTime

public final String getModificationTime()

Returns:

Returns the modification time.

getChangeType

public int getChangeType()

Returns:

Returns the changeType. For example ChangeConstants.INSERT_CHANGE or ChangeConstants.DELETE_CHANGE.

compareTo

public int compareTo(ChangeMarker o)

It compares the start offset of the current change marker with the start offset of the other one.

Specified by:

compareTo in interface Comparable<ChangeMarker>

See Also:

Comparable.compareTo(java.lang.Object)

containsOffset

public boolean containsOffset(int offset)

Returns true if the given offset is located between the start and end offsets of the current change marker.

Parameters:

offset - The offset to be verified.

Returns:

True if the change marker contains the offset.

getStartOffset

public abstract int getStartOffset()

Returns:

The start offset of the change.

getEndOffset

public abstract int getEndOffset()

Returns:

The end offset of the change.

getDescription

public String getDescription()

Get the change marker description.
For example the description for an insertion can be:
"Inserted by name_of_author
modification_time"

Returns:

A string description of the change marker.

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

setAuthorComment

public void setAuthorComment(String authorComment)

Parameters:

authorComment - The author comment.

getAuthorComment

public String getAuthorComment()

Returns:

Returns the author comment.