ACS-10.0 Java API: cl.utfsm.acs.ebe.EbeDocument Class Reference

Inheritance diagram for cl.utfsm.acs.ebe.EbeDocument:

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

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 ( )

Initialize a new EbeDocument

References cl.utfsm.acs.ebe.EbeDocument.nodes, and cl.utfsm.acs.ebe.EbeDocument.typeType.

Member Function Documentation

static AcsComplexType cl.utfsm.acs.ebe.EbeDocument.getClassType ( ) [static]

The class type getter

References cl.utfsm.acs.ebe.EbeDocument.typeType.

ComplexObject cl.utfsm.acs.ebe.EbeDocument.getNode ( String name )

Get a node by name

Parameters:

name

a name to get the node

Returns:: a ComplexNode

References cl.utfsm.acs.ebe.EbeDocument.nodes.

TreeMap<String,ComplexObject> cl.utfsm.acs.ebe.EbeDocument.getNodes ( )

Get the nodes (completion/error) TreeMap

Returns:: the nodes TreeMap

References cl.utfsm.acs.ebe.EbeDocument.nodes.

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

String cl.utfsm.acs.ebe.EbeDocument.getPath ( )

Get the current filename Path

Returns:: the path

Referenced by cl.utfsm.acs.ebe.EbeDocumentManager.deleteDocument(), and cl.utfsm.acs.ebe.EbeDocument.save().

void cl.utfsm.acs.ebe.EbeDocument.load ( )

Load the data from the selected path

References cl.utfsm.acs.ebe.EbeDocument.nodes, cl.utfsm.acs.ebe.Error.putMember(), and cl.utfsm.acs.ebe.EbeDocument.putNode().

Referenced by cl.utfsm.acs.ebe.EbeDocumentManager.loadDocument().

void cl.utfsm.acs.ebe.EbeDocument.putNode ( ComplexObject obj )

Add a node (completion/error) to the document

Parameters:

obj

the Object to add

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

Referenced by cl.utfsm.acs.ebe.EbeDocument.load().

void cl.utfsm.acs.ebe.EbeDocument.save ( ) throws FileNotFoundException, IOException

Save the data to the selected path

Exceptions:

	IOException
	FileNotFoundException

References cl.utfsm.acs.ebe.Error.getMembers(), cl.utfsm.acs.ebe.EbeDocument.getPath(), and cl.utfsm.acs.ebe.EbeDocument.nodes.

static void cl.utfsm.acs.ebe.EbeDocument.setClassType ( AcsComplexType t ) [static]

The class type setter

References cl.utfsm.acs.ebe.EbeDocument.typeType.

void cl.utfsm.acs.ebe.EbeDocument.setDocumentInfo	(	String	_prefix,
		String	xsi,
		String	xsiNamespace,
		String	xsiLocation,
		String	name
	)

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(), and cl.utfsm.acs.ebe.EbeDocument.setDocumentInfo().

void cl.utfsm.acs.ebe.EbeDocument.setDocumentInfo ( String name )

Set the basic document info defaults

Parameters:

name

the document name

References cl.utfsm.acs.ebe.EbeDocument.setDocumentInfo().

void cl.utfsm.acs.ebe.EbeDocument.setPath ( String path )

Set the Path of the Document

Parameters:

path

the absolute path to the file

Referenced by cl.utfsm.acs.ebe.EbeDocumentManager.loadDocument(), and cl.utfsm.acs.ebe.EbeDocumentManager.newDocument().

Member Data Documentation

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

The nodes (completions and errors) TreeMap

Referenced by cl.utfsm.acs.ebe.EbeDocument.EbeDocument(), cl.utfsm.acs.ebe.EbeDocument.getNode(), cl.utfsm.acs.ebe.EbeDocument.getNodes(), cl.utfsm.acs.ebe.EbeDocument.load(), cl.utfsm.acs.ebe.EbeDocument.putNode(), and cl.utfsm.acs.ebe.EbeDocument.save().

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

The class type

Referenced by cl.utfsm.acs.ebe.EbeDocument.EbeDocument(), cl.utfsm.acs.ebe.EbeDocument.getClassType(), and cl.utfsm.acs.ebe.EbeDocument.setClassType().

The documentation for this class was generated from the following file:

EbeDocument.java

All Classes Namespaces Files Functions Variables Enumerations Properties