icy.update

Class ElementDescriptor

java.lang.Object

icy.update.ElementDescriptor

All Implemented Interfaces:

XMLPersistent

public class ElementDescriptor
extends java.lang.Object
implements XMLPersistent

Author:

stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ElementDescriptor.ElementFile

Constructor Summary

Constructors

Constructor and Description
ElementDescriptor(ElementDescriptor element) Create a new element descriptor using specified element informations
ElementDescriptor(org.w3c.dom.Node node)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addElementFile(ElementDescriptor.ElementFile file)
java.lang.String	getChangelog()
ElementDescriptor.ElementFile	getElementFile(java.lang.String localPath) return ElementFile containing specified local path
ElementDescriptor.ElementFile	getFile(int index)
java.util.ArrayList<ElementDescriptor.ElementFile>	getFiles()
int	getFilesNumber()
java.lang.String	getName()
static ElementDescriptor	getUpdateElement(ElementDescriptor localElement, ElementDescriptor onlineElement) Process and return the update the element which contain differences from the specified local and online elements.
Version	getVersion()
boolean	hasLocalPath(java.lang.String localPath) return true if element contains the specified local path
boolean	isSame(ElementDescriptor element, boolean compareFileOnlinePath) Return true if the specified ElementDescriptor is the same than current one.
boolean	isValid()
boolean	loadFromXML(org.w3c.dom.Node node) LOAD
boolean	removeElementFile(ElementDescriptor.ElementFile file)
void	removeElementFile(java.lang.String localPath)
boolean	saveToNode(org.w3c.dom.Node node, boolean onlineSave)
boolean	saveToXML(org.w3c.dom.Node node) SAVE
void	setVersion(Version version)
java.lang.String	toString()
void	update(ElementDescriptor updateElement) Update current element with informations from specified element
boolean	validate() Validate the current element descriptor.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ElementDescriptor

public ElementDescriptor(org.w3c.dom.Node node)

ElementDescriptor

public ElementDescriptor(ElementDescriptor element)

Create a new element descriptor using specified element informations

Method Detail

loadFromXML

public boolean loadFromXML(org.w3c.dom.Node node)

Description copied from interface: XMLPersistent

LOAD

Specified by:

loadFromXML in interface XMLPersistent

saveToXML

public boolean saveToXML(org.w3c.dom.Node node)

Description copied from interface: XMLPersistent

SAVE

Specified by:

saveToXML in interface XMLPersistent

saveToNode

public boolean saveToNode(org.w3c.dom.Node node,
                 boolean onlineSave)

getElementFile

public ElementDescriptor.ElementFile getElementFile(java.lang.String localPath)

return ElementFile containing specified local path

hasLocalPath

public boolean hasLocalPath(java.lang.String localPath)

return true if element contains the specified local path

addElementFile

public boolean addElementFile(ElementDescriptor.ElementFile file)

removeElementFile

public boolean removeElementFile(ElementDescriptor.ElementFile file)

removeElementFile

public void removeElementFile(java.lang.String localPath)

validate

public boolean validate()

Validate the current element descriptor.
It actually remove missing files from the element.
Return true if all files are valid.

isValid

public boolean isValid()

getName

public java.lang.String getName()

Returns:

the name

getVersion

public Version getVersion()

Returns:

the version

getFilesNumber

public int getFilesNumber()

Returns:

the number of files

getFiles

public java.util.ArrayList<ElementDescriptor.ElementFile> getFiles()

Returns:

the files

getFile

public ElementDescriptor.ElementFile getFile(int index)

Returns:

the specified file

getChangelog

public java.lang.String getChangelog()

Returns:

the changelog

setVersion

public void setVersion(Version version)

Parameters:

version - the version to set

isSame

public boolean isSame(ElementDescriptor element,
             boolean compareFileOnlinePath)

Return true if the specified ElementDescriptor is the same than current one.

Parameters:

element - the element descriptor to compare

compareFileOnlinePath - specify if we compare file online path information

getUpdateElement

public static ElementDescriptor getUpdateElement(ElementDescriptor localElement,
                                 ElementDescriptor onlineElement)

Process and return the update the element which contain differences
from the specified local and online elements.
If local element refers the same item, only missing or different files will remains.
If local element refers a different element, online element is returned unchanged.

Returns:

the update element (null if local and online elements are the same)

update

public void update(ElementDescriptor updateElement)

Update current element with informations from specified element

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object