org.apache.jackrabbit.mongomk.impl.model

Class MongoCommit

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,Object>

org.bson.BasicBSONObject

com.mongodb.BasicDBObject

org.apache.jackrabbit.mongomk.impl.model.MongoCommit

All Implemented Interfaces:

com.mongodb.DBObject, Serializable, Cloneable, Map<String,Object>, Commit, org.bson.BSONObject

public class MongoCommit
extends com.mongodb.BasicDBObject
implements Commit

The MongoDB representation of a commit.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_AFFECTED_PATH
static String	KEY_BASE_REVISION_ID
static String	KEY_BRANCH_ID
static String	KEY_DIFF
static String	KEY_FAILED
static String	KEY_MESSAGE
static String	KEY_PATH
static String	KEY_REVISION_ID
static String	KEY_TIMESTAMP

Constructor Summary

Constructors

Constructor and Description
MongoCommit() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addInstruction(Instruction instruction) Adds the given Instruction.
SortedSet<String>	getAffectedPaths() Returns the paths affected by the commit.
Long	getBaseRevisionId() Returns the base revision id the commit is based on.
String	getBranchId() Returns the private branch id the commit is under or null if the commit is in the public branch.
String	getDiff() Returns the JSOP diff of this commit.
List<Instruction>	getInstructions() Returns the List of Instructions which were created from the diff.
String	getMessage() Returns the message of the commit.
String	getPath() Returns the path of the root node of this commit.
Long	getRevisionId() Returns the revision id of this commit if known already, else this will return null.
Long	getTimestamp() Returns the timestamp of this commit.
boolean	isFailed() Determines whether the commit failed or not.
void	setAffectedPaths(Set<String> affectedPaths)
void	setBaseRevisionId(Long baseRevisionId)
void	setBranchId(String branchId)
void	setDiff(String diff)
void	setFailed()
void	setMessage(String message)
void	setPath(String path)
void	setRevisionId(Long revisionId) Sets the revision id of this commit.
void	setTimestamp(Long timestamp)

Methods inherited from class com.mongodb.BasicDBObject

append, copy, isPartialObject, markAsPartialObject, toString

Methods inherited from class org.bson.BasicBSONObject

containsField, containsKey, equals, get, getBoolean, getBoolean, getDate, getDate, getDouble, getDouble, getInt, getInt, getLong, getLong, getObjectId, getObjectId, getString, getString, put, putAll, putAll, removeField, toMap

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, get, removeEldestEntry

Methods inherited from class java.util.HashMap

clone, containsKey, entrySet, isEmpty, keySet, remove, size, values

Methods inherited from class java.util.AbstractMap

hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.bson.BSONObject

containsField, containsKey, get, keySet, put, putAll, putAll, removeField, toMap

Methods inherited from interface java.util.Map

containsKey, entrySet, hashCode, isEmpty, keySet, remove, size, values

Field Detail

KEY_AFFECTED_PATH

public static final String KEY_AFFECTED_PATH

See Also:

Constant Field Values

KEY_BASE_REVISION_ID

public static final String KEY_BASE_REVISION_ID

See Also:

Constant Field Values

KEY_BRANCH_ID

public static final String KEY_BRANCH_ID

See Also:

Constant Field Values

KEY_DIFF

public static final String KEY_DIFF

See Also:

Constant Field Values

KEY_FAILED

public static final String KEY_FAILED

See Also:

Constant Field Values

KEY_MESSAGE

public static final String KEY_MESSAGE

See Also:

Constant Field Values

KEY_PATH

public static final String KEY_PATH

See Also:

Constant Field Values

KEY_REVISION_ID

public static final String KEY_REVISION_ID

See Also:

Constant Field Values

KEY_TIMESTAMP

public static final String KEY_TIMESTAMP

See Also:

Constant Field Values

Constructor Detail

MongoCommit

public MongoCommit()

Default constructor. Needed for MongoDB serialization.

Method Detail

getAffectedPaths

public SortedSet<String> getAffectedPaths()

Description copied from interface: Commit

Returns the paths affected by the commit.

Specified by:

getAffectedPaths in interface Commit

Returns:

The paths affected by the commit.

setAffectedPaths

public void setAffectedPaths(Set<String> affectedPaths)

getBaseRevisionId

public Long getBaseRevisionId()

Description copied from interface: Commit

Returns the base revision id the commit is based on.

Specified by:

getBaseRevisionId in interface Commit

Returns:

The base revision id the commit is based on.

setBaseRevisionId

public void setBaseRevisionId(Long baseRevisionId)

getBranchId

public String getBranchId()

Description copied from interface: Commit

Returns the private branch id the commit is under or null if the commit is in the public branch.

Specified by:

getBranchId in interface Commit

Returns:

The private branch id or null

setBranchId

public void setBranchId(String branchId)

getDiff

public String getDiff()

Description copied from interface: Commit

Returns the JSOP diff of this commit.

Specified by:

getDiff in interface Commit

Returns:

The String representing the diff.

setDiff

public void setDiff(String diff)

isFailed

public boolean isFailed()

Description copied from interface: Commit

Determines whether the commit failed or not.

Specified by:

isFailed in interface Commit

Returns:

True if the commit failed.

setFailed

public void setFailed()

getMessage

public String getMessage()

Description copied from interface: Commit

Returns the message of the commit.

Specified by:

getMessage in interface Commit

Returns:

The message.

setMessage

public void setMessage(String message)

getPath

public String getPath()

Description copied from interface: Commit

Returns the path of the root node of this commit.

Specified by:

getPath in interface Commit

Returns:

The path of the root node.

setPath

public void setPath(String path)

getRevisionId

public Long getRevisionId()

Description copied from interface: Commit

Returns the revision id of this commit if known already, else this will return null. The revision id will be determined only after the commit has been successfully performed.

Specified by:

getRevisionId in interface Commit

Returns:

The revision id of this commit or null.

setRevisionId

public void setRevisionId(Long revisionId)

Description copied from interface: Commit

Sets the revision id of this commit.

Specified by:

setRevisionId in interface Commit

Parameters:

revisionId - The revision id to set.

getTimestamp

public Long getTimestamp()

Description copied from interface: Commit

Returns the timestamp of this commit.

Specified by:

getTimestamp in interface Commit

Returns:

The timestamp of this commit.

setTimestamp

public void setTimestamp(Long timestamp)

addInstruction

public void addInstruction(Instruction instruction)

Adds the given Instruction.

Parameters:

instruction - The Instruction.

getInstructions

public List<Instruction> getInstructions()

Description copied from interface: Commit

Returns the List of Instructions which were created from the diff.

Specified by:

getInstructions in interface Commit

Returns:

The List of Instructions.

See Also:

Commit.getDiff()