cl::utfsm::acs::ebe::EbeDocument Class Reference

Inheritance diagram for cl::utfsm::acs::ebe::EbeDocument:
Inheritance graph
[legend]
Collaboration diagram for cl::utfsm::acs::ebe::EbeDocument:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 EbeDocument ()
void setPath (String path)
String getPath ()
void load ()
void save () throws FileNotFoundException, IOException
void putNode (ComplexObject obj)
TreeMap< String, ComplexObject > getNodes ()
ComplexObject getNode (String name)
void setDocumentInfo (String _prefix, String xsi, String xsiNamespace, String xsiLocation, String name)
void setDocumentInfo (String name)

Static Public Member Functions

static void setClassType (AcsComplexType t)
static AcsComplexType getClassType ()

Protected Attributes

TreeMap< String, ComplexObject > nodes

Static Protected Attributes

static AcsComplexType typeType

Private Member Functions

void readNode (Node no, ComplexObject obj)
void fillAttributes (ComplexObject obj, Element toFill)
void saveXmlDocument (Document docu, String name) throws FileNotFoundException, java.io.IOException

Private Attributes

String path
Document doc

Static Private Attributes

static DOMParser parser

Detailed Description

Error Browser and Editor Document object. This object is the representation of a document (and a file). This is the start point for any client. Each document is a ComplexObject, as all its contents.

Author:
Mauricio Araya (maray[at]inf.utfsm.cl)

Constructor & Destructor Documentation

cl::utfsm::acs::ebe::EbeDocument::EbeDocument (  )  [inline]

Initialize a new EbeDocument

References nodes, and typeType.

Member Function Documentation

void cl::utfsm::acs::ebe::EbeDocument::fillAttributes ( ComplexObject  obj,
Element  toFill 
) [inline, private]

Fill a DOM Element from a ComplexObject (for save)

Parameters:
obj the ComplexObject with attributes
toFill the DOM element to fill

References cl::utfsm::acs::types::ComplexObject::getAttributes(), and cl::utfsm::acs::types::ComplexObject::getAttributeValue().

Referenced by save().

static AcsComplexType cl::utfsm::acs::ebe::EbeDocument::getClassType (  )  [inline, static]

The class type getter

References typeType.

ComplexObject cl::utfsm::acs::ebe::EbeDocument::getNode ( String  name  )  [inline]

Get a node by name

Parameters:
name a name to get the node
Returns:
a ComplexNode

References nodes.

Referenced by cl::utfsm::acs::ebe::ErrorBrowserEditor::getNewCompletionMenuItem(), cl::utfsm::acs::ebe::ErrorBrowserEditor::getNewErrorMenuItem(), and cl::utfsm::acs::ebe::EbeDocumentTEST::testLoad().

TreeMap<String,ComplexObject> cl::utfsm::acs::ebe::EbeDocument::getNodes (  )  [inline]

Get the nodes (completion/error) TreeMap

Returns:
the nodes TreeMap

References nodes.

Referenced by cl::utfsm::acs::ebe::ErrorBrowserEditor::getRemoveNodeButton(), cl::utfsm::acs::ebe::EbeDocumentManager::loadDocument(), cl::utfsm::acs::ebe::ErrorBrowserEditor::refreshNodesTree(), and cl::utfsm::acs::ebe::util::EbeTableModel::setValueAt().

String cl::utfsm::acs::ebe::EbeDocument::getPath (  )  [inline]

Get the current filename Path

Returns:
the path

References path.

Referenced by cl::utfsm::acs::ebe::EbeDocumentManager::deleteDocument(), cl::utfsm::acs::ebe::ErrorBrowserEditor::enterEditMode(), cl::utfsm::acs::ebe::ErrorBrowserEditor::getDocsTree(), cl::utfsm::acs::ebe::ErrorBrowserEditor::getSaveButton(), cl::utfsm::acs::ebe::ErrorBrowserEditor::loadXmlView(), and save().

void cl::utfsm::acs::ebe::EbeDocument::load (  )  [inline]

Load the data from the selected path

References doc, nodes, parser, path, cl::utfsm::acs::ebe::Error::putMember(), putNode(), and readNode().

Referenced by cl::utfsm::acs::ebe::ErrorBrowserEditor::getCancelEditButton(), cl::utfsm::acs::ebe::ErrorBrowserEditor::getSaveButton(), cl::utfsm::acs::ebe::EbeDocumentManager::loadDocument(), and cl::utfsm::acs::ebe::EbeDocumentTEST::testLoad().

void cl::utfsm::acs::ebe::EbeDocument::putNode ( ComplexObject  obj  )  [inline]

Add a node (completion/error) to the document

Parameters:
obj the Object to add

References cl::utfsm::acs::types::TypedObject::getValue(), and nodes.

Referenced by cl::utfsm::acs::ebe::ErrorBrowserEditor::getNewCompletionMenuItem(), cl::utfsm::acs::ebe::ErrorBrowserEditor::getNewErrorMenuItem(), load(), and cl::utfsm::acs::ebe::EbeDocumentTEST::testSave().

void cl::utfsm::acs::ebe::EbeDocument::readNode ( Node  no,
ComplexObject  obj 
) [inline, private]

Read the node into a ComplexObject

Parameters:
no the DOM node to read
obj the Complex Object to fill

References cl::utfsm::acs::types::ComplexObject::setAttributeValue(), and cl::utfsm::acs::types::TypedObject::setValue().

Referenced by load().

void cl::utfsm::acs::ebe::EbeDocument::save (  )  throws FileNotFoundException, IOException [inline]

Save the data to the selected path

Exceptions:
IOException 
FileNotFoundException 

References fillAttributes(), cl::utfsm::acs::ebe::Error::getMembers(), getPath(), nodes, and saveXmlDocument().

Referenced by cl::utfsm::acs::ebe::ErrorBrowserEditor::getSaveButton(), and cl::utfsm::acs::ebe::EbeDocumentTEST::testSave().

void cl::utfsm::acs::ebe::EbeDocument::saveXmlDocument ( Document  docu,
String  name 
) throws FileNotFoundException, java.io.IOException [inline, private]

Save the DOM document into the name path

Parameters:
docu The DOM document
name the filename path

Referenced by save().

static void cl::utfsm::acs::ebe::EbeDocument::setClassType ( AcsComplexType  t  )  [inline, static]

The class type setter

References typeType.

void cl::utfsm::acs::ebe::EbeDocument::setDocumentInfo ( String  name  )  [inline]

Set the basic document info defaults

Parameters:
name the document name

References setDocumentInfo().

void cl::utfsm::acs::ebe::EbeDocument::setDocumentInfo ( String  _prefix,
String  xsi,
String  xsiNamespace,
String  xsiLocation,
String  name 
) [inline]

Set the basic document info

Parameters:
_prefix prefix (like alma)
xsi xsi info
xsiLocation the xsi location
name the document name

References cl::utfsm::acs::types::ComplexObject::setAttributeValue().

Referenced by cl::utfsm::acs::ebe::EbeDocumentManager::newDocument(), setDocumentInfo(), and cl::utfsm::acs::ebe::EbeDocumentTEST::testSave().

void cl::utfsm::acs::ebe::EbeDocument::setPath ( String  path  )  [inline]

Set the Path of the Document

Parameters:
path the absolute path to the file

Referenced by cl::utfsm::acs::ebe::EbeDocumentManager::loadDocument(), cl::utfsm::acs::ebe::EbeDocumentManager::newDocument(), cl::utfsm::acs::ebe::EbeDocumentTEST::testLoad(), and cl::utfsm::acs::ebe::EbeDocumentTEST::testSave().

Member Data Documentation

Document cl::utfsm::acs::ebe::EbeDocument::doc [private]

The DOM document

Referenced by load().

TreeMap<String,ComplexObject> cl::utfsm::acs::ebe::EbeDocument::nodes [protected]

The nodes (completions and errors) TreeMap

Referenced by EbeDocument(), getNode(), getNodes(), load(), putNode(), and save().

DOMParser cl::utfsm::acs::ebe::EbeDocument::parser [static, private]

The common DOM parser

Referenced by load().

String cl::utfsm::acs::ebe::EbeDocument::path [private]

The file path

Referenced by getPath(), and load().

AcsComplexType cl::utfsm::acs::ebe::EbeDocument::typeType [static, protected]

The class type

Referenced by EbeDocument(), getClassType(), and setClassType().

The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.2