rescuecore2.worldmodel

Class ChangeSet

java.lang.Object

rescuecore2.worldmodel.ChangeSet

public class ChangeSet
extends java.lang.Object

This class is used for accumulating changes to entities.

Constructor Summary

Constructors

Constructor and Description
ChangeSet() Create an empty ChangeSet.
ChangeSet(ChangeSet other) Copy constructor.

Method Summary

Modifier and Type	Method and Description
void	addAll(java.util.Collection<? extends Entity> c) Add all defined properties from a collection.
void	addChange(EntityID e, java.lang.String urn, Property p) Add a change.
void	addChange(Entity e, Property p) Add a change.
void	debug() Write this changeset to Logger.debug in a readable form.
void	entityDeleted(EntityID e) Register a deleted entity.
java.util.Set<EntityID>	getChangedEntities() Get the IDs of all changed entities.
java.util.Set<Property>	getChangedProperties(EntityID e) Get the properties that have changed for an entity.
Property	getChangedProperty(EntityID e, java.lang.String urn) Look up a property change for an entity by property URN.
java.util.Set<EntityID>	getDeletedEntities() Get the IDs of all deleted entities.
java.lang.String	getEntityURN(EntityID id) Get the URN of a changed entity.
void	merge(ChangeSet other) Merge another ChangeSet into this one.
void	read(java.io.InputStream in) Read this ChangeSet from a stream.
java.lang.String	toString()
void	write(java.io.OutputStream out) Write this ChangeSet to a stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeSet

public ChangeSet()

Create an empty ChangeSet.

ChangeSet

public ChangeSet(ChangeSet other)

Copy constructor.

Parameters:

other - The ChangeSet to copy.

Method Detail

addChange

public void addChange(Entity e,
                      Property p)

Add a change.

Parameters:

e - The entity that has changed.

p - The property that has changed.

addChange

public void addChange(EntityID e,
                      java.lang.String urn,
                      Property p)

Add a change.

Parameters:

e - The ID of the entity that has changed.

urn - The URN of the entity that has changed.

p - The property that has changed.

entityDeleted

public void entityDeleted(EntityID e)

Register a deleted entity.

Parameters:

e - The ID of the entity that has been deleted.

getChangedProperties

public java.util.Set<Property> getChangedProperties(EntityID e)

Get the properties that have changed for an entity.

Parameters:

e - The entity ID to look up.

Returns:

The set of changed properties. This may be empty but will never be null.

getChangedProperty

public Property getChangedProperty(EntityID e,
                                   java.lang.String urn)

Look up a property change for an entity by property URN.

Parameters:

e - The entity ID to look up.

urn - The property URN to look up.

Returns:

The changed property with the right URN, or null if the property is not found or has not changed.

getChangedEntities

public java.util.Set<EntityID> getChangedEntities()

Get the IDs of all changed entities.

Returns:

A set of IDs of changed entities.

getDeletedEntities

public java.util.Set<EntityID> getDeletedEntities()

Get the IDs of all deleted entities.

Returns:

A set of IDs of deleted entities.

getEntityURN

public java.lang.String getEntityURN(EntityID id)

Get the URN of a changed entity.

Parameters:

id - The ID of the entity.

Returns:

The URN of the changed entity.

merge

public void merge(ChangeSet other)

Merge another ChangeSet into this one.

Parameters:

other - The other ChangeSet.

addAll

public void addAll(java.util.Collection<? extends Entity> c)

Add all defined properties from a collection.

Parameters:

c - The collection to copy changes from.

write

public void write(java.io.OutputStream out)
           throws java.io.IOException

Write this ChangeSet to a stream.

Parameters:

out - The stream to write to.

Throws:

java.io.IOException - If there is a problem.

read

public void read(java.io.InputStream in)
          throws java.io.IOException

Read this ChangeSet from a stream.

Parameters:

in - The stream to read from.

Throws:

java.io.IOException - If there is a problem.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

debug

public void debug()

Write this changeset to Logger.debug in a readable form.