pt.lsts.neptus.types.checklist

Class ChecklistType

java.lang.Object

pt.lsts.neptus.types.checklist.ChecklistType

All Implemented Interfaces:

XmlInputMethods, XmlInputMethodsFromFile, XmlOutputMethods

public class ChecklistType
extends java.lang.Object
implements XmlOutputMethods, XmlInputMethods, XmlInputMethodsFromFile

Refactored in 06/11/2006.

Author:

Paulo Dias

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_ROOT_ELEMENT
protected java.lang.String	description
static java.lang.String	FLAT_ID
protected java.util.LinkedHashMap<java.lang.String,java.util.LinkedList<CheckItem>>	groupList >
protected boolean	isFlat
protected boolean	isLoadOk
protected java.lang.String	name
protected java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
ChecklistType()
ChecklistType(java.lang.String url)

Method Summary

Modifier and Type	Method and Description
org.dom4j.Document	asDocument()
org.dom4j.Document	asDocument(java.lang.String rootElementName)
org.dom4j.Element	asElement()
org.dom4j.Element	asElement(java.lang.String rootElementName)
java.lang.String	asXML() Este problema foi resolvido com a versão 1.6.1 do DOM4J.
java.lang.String	asXML(java.lang.String rootElementName) Este problema foi resolvido com a versão 1.6.1 do DOM4J.
protected java.lang.Object	clone()
ChecklistType	createCopy()
ChecklistMission	getCheckListMission()
java.lang.String	getDescription()
java.util.LinkedHashMap<java.lang.String,java.util.LinkedList<CheckItem>>	getGroupList()
java.lang.String	getName()
java.lang.String	getOriginalFilePath()
java.lang.String	getVersion()
boolean	isFlat()
boolean	isLoadOk()
boolean	isTotallyChecked()
boolean	load(org.dom4j.Element elem) Should set XmlInputMethods.isLoadOk() return value.
boolean	load(java.lang.String xml) Should set XmlInputMethods.isLoadOk() return value.
boolean	loadFile(java.io.File file) Should set XmlInputMethods.isLoadOk() return value.
boolean	loadFile(java.lang.String url) Should set XmlInputMethods.isLoadOk() return value.
void	setDescription(java.lang.String description)
void	setFlat(boolean isFlat)
void	setName(java.lang.String name)
void	setOriginalFilePath(java.lang.String originalFilePath)
void	setVersion(java.lang.String version)
java.lang.String	toString()
static boolean	validate(java.io.File file)
static boolean	validate(java.lang.String xml)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ROOT_ELEMENT

protected static final java.lang.String DEFAULT_ROOT_ELEMENT

See Also:

Constant Field Values

FLAT_ID

public static final java.lang.String FLAT_ID

See Also:

Constant Field Values

name

protected java.lang.String name

version

protected java.lang.String version

description

protected java.lang.String description

isFlat

protected boolean isFlat

isLoadOk

protected boolean isLoadOk

groupList

protected java.util.LinkedHashMap<java.lang.String,java.util.LinkedList<CheckItem>> groupList

>

Constructor Detail

ChecklistType

public ChecklistType(java.lang.String url)

ChecklistType

public ChecklistType()

Method Detail

load

public boolean load(org.dom4j.Element elem)

Description copied from interface: XmlInputMethods

Should set XmlInputMethods.isLoadOk() return value.

Specified by:

load in interface XmlInputMethods

Returns:

load

public boolean load(java.lang.String xml)

Description copied from interface: XmlInputMethods

Should set XmlInputMethods.isLoadOk() return value.

Specified by:

load in interface XmlInputMethods

Returns:

loadFile

public boolean loadFile(java.io.File file)

Description copied from interface: XmlInputMethodsFromFile

Should set XmlInputMethods.isLoadOk() return value. You should also call the XSD validation(you can use XMLValidator).

Specified by:

loadFile in interface XmlInputMethodsFromFile

Returns:

loadFile

public boolean loadFile(java.lang.String url)

Description copied from interface: XmlInputMethodsFromFile

Should set XmlInputMethods.isLoadOk() return value. You should also call the XSD validation(you can use XMLValidator).

Specified by:

loadFile in interface XmlInputMethodsFromFile

Parameters:

url -

Returns:

getName

public java.lang.String getName()

Returns:

Returns the name.

setName

public void setName(java.lang.String name)

Parameters:

name - The name to set.

getVersion

public java.lang.String getVersion()

Returns:

the version

setVersion

public void setVersion(java.lang.String version)

Parameters:

version - the version to set

getDescription

public java.lang.String getDescription()

Returns:

Returns the description.

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - The description to set.

isFlat

public boolean isFlat()

Returns:

Returns the isFlat.

setFlat

public void setFlat(boolean isFlat)

Parameters:

isFlat - The isFlat to set.

getGroupList

public java.util.LinkedHashMap<java.lang.String,java.util.LinkedList<CheckItem>> getGroupList()

Returns:

Returns the groupList.

getOriginalFilePath

public java.lang.String getOriginalFilePath()

Returns:

Returns the originalFilePath.

setOriginalFilePath

public void setOriginalFilePath(java.lang.String originalFilePath)

Parameters:

originalFilePath - The originalFilePath to set.

asXML

public java.lang.String asXML()

Description copied from interface: XmlOutputMethods

Este problema foi resolvido com a versão 1.6.1 do DOM4J.

Atenção ao usar este método com o método FileUtil.saveToFile(String, String) e afins. Isto porque ao gravar como UTF-8 os caracteres são adulterados guardando por exemplo "é" em 2 caracteres (ou seja pega nos dois caracteres UTF-8 e transforma-os em 2 UTF-8s).

Specified by:

asXML in interface XmlOutputMethods

Returns:

asXML

public java.lang.String asXML(java.lang.String rootElementName)

Description copied from interface: XmlOutputMethods

Este problema foi resolvido com a versão 1.6.1 do DOM4J.

Atenção ao usar este método com o método FileUtil.saveToFile(String, String) e afins. Isto porque ao gravar como UTF-8 os caracteres são adulterados guardando por exemplo "é" em 2 caracteres (ou seja pega nos dois caracteres UTF-8 e transforma-os em 2 UTF-8s).

Specified by:

asXML in interface XmlOutputMethods

Returns:

asElement

public org.dom4j.Element asElement()

Specified by:

asElement in interface XmlOutputMethods

Returns:

asElement

public org.dom4j.Element asElement(java.lang.String rootElementName)

Specified by:

asElement in interface XmlOutputMethods

Returns:

asDocument

public org.dom4j.Document asDocument()

Specified by:

asDocument in interface XmlOutputMethods

Returns:

asDocument

public org.dom4j.Document asDocument(java.lang.String rootElementName)

Specified by:

asDocument in interface XmlOutputMethods

Returns:

isLoadOk

public boolean isLoadOk()

Specified by:

isLoadOk in interface XmlInputMethods

Returns:

If the load of the XML was successful.

validate

public static boolean validate(java.lang.String xml)

isTotallyChecked

public boolean isTotallyChecked()

validate

public static boolean validate(java.io.File file)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCheckListMission

public ChecklistMission getCheckListMission()

createCopy

public ChecklistType createCopy()

clone

protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException