Java Doc for ExternalStructure.java in » Testing » jacareto » jacareto » struct » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Testing » jacareto » jacareto.struct

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

jacareto.system .EnvironmentMember

jacareto.struct .ExternalStructure

All known Subclasses:   jacareto.struct .XMLStructure,
ExternalStructure
abstract public class ExternalStructure extends EnvironmentMember (Code)
This abstract class represents a structure of structure elements or other objects.
Heirs of this abstract class must decide how object should be stored and how they should be read from a structure. Possible heirs could be XMLStructure.

Objects which can be stored to a structure are structure element (see StructureElement ). The record is setted by the method ExternalStructure.setRecord(jacareto.record.ReadAccessRecord) and the structure is stored with the methode ExternalStructure.setRootElement(StructureElement) .

Subclasses should call the ExternalStructure.fireStructureChange(StructureChangeEvent) method whenever the content or the state of the structure changes. This method notifies all StructureChangeListeners added to this object of the structure change.

author:
   Markus Bois
version:
   1.01

Constructor Summary
public ExternalStructure(Environment env)
     The constructor.

Method Summary
public void addStructureChangeListener(StructureChangeListener listener)
     Adds a structure change listener to the list of structure change listeners.
abstract public void close()
     Finishes adding.
protected void fireStructureChange(StructureChangeEvent event)
     Fires a structure change (content or state) to all structure change listeners.
abstract public ReadAccessRecord getRecord()
     Returns the record of the extrnal structure.
abstract public String getRecordName()
     Returns the name of the stored record.
abstract public StructureElement getRootElement()
     Returns the root element of the structure.
public boolean isEmpty()
     Returns whether this structure has at least one element or not.
public boolean isNotificationEnabled()
     Returns whether or not structure change listeners will be notified of structure changes.
abstract public boolean isOpen()
     Returns true if the structure is open, otherwise false.
abstract public void open()
     Makes this structure get ready for storing.
public void removeStructureChangeListener(StructureChangeListener listener)
     Removes a structure change listener from the list of structure change listeners.
public void setNotificationEnabled(boolean isNotificationEnabled)
     Specifies whether or not structure change listeners should be notified of structure changes.
abstract public void setRecord(ReadAccessRecord record)
     Sets the record of the recordables.
abstract public void setRecordName(String recordName)
     Sets the name of the stored record.
abstract public void setRootElement(StructureElement root)
     Set the root element of the structure.
abstract public int size()
     Returns the number of elements stored in the structure.

Constructor Detail
ExternalStructure
public ExternalStructure(Environment env)(Code)
The constructor.
Parameters:
  env - the environment

Method Detail
addStructureChangeListener
public void addStructureChangeListener(StructureChangeListener listener)(Code)
Adds a structure change listener to the list of structure change listeners. All listeners will be notified when this structure changes.
Parameters:
  listener - the listener to add

close
abstract public void close() throws StructureException(Code)
Finishes adding. Should throw a StructureException if the structure is not open, for example.
throws:
  StructureException - if an error has occurred

fireStructureChange
protected void fireStructureChange(StructureChangeEvent event)(Code)
Fires a structure change (content or state) to all structure change listeners.
Parameters:
  event - the event wich contains the information of the change

getRecord
abstract public ReadAccessRecord getRecord() throws StructureException(Code)
Returns the record of the extrnal structure. If there is no converter registered for a sort of xml elements, they will not be in the structure. record of the extrnal structure
throws:
  StructureException - if the structure is not open

getRecordName
abstract public String getRecordName()(Code)
Returns the name of the stored record. the name of the record as String

getRootElement
abstract public StructureElement getRootElement() throws StructureException(Code)
Returns the root element of the structure. If there is no converter registered for a sort of xml elements, they will not be in the structure. root element of the structure
throws:
  StructureException - if the structure is not open

isEmpty
public boolean isEmpty() throws StructureException(Code)
Returns whether this structure has at least one element or not. Should throw a StructureException if the structure is not open, for example. true if this structure is empty, otherwise false
throws:
  StructureException - if an error has occurred

isNotificationEnabled
public boolean isNotificationEnabled()(Code)
Returns whether or not structure change listeners will be notified of structure changes. DOCUMENT ME!

isOpen
abstract public boolean isOpen()(Code)
Returns true if the structure is open, otherwise false. DOCUMENT ME!

open
abstract public void open() throws StructureException(Code)
Makes this structure get ready for storing. Should throw a StructureException if the structure is already open, for example.
throws:
  StructureException - if an error has occurred

removeStructureChangeListener
public void removeStructureChangeListener(StructureChangeListener listener)(Code)
Removes a structure change listener from the list of structure change listeners.
Parameters:
  listener - the listener to remove

setNotificationEnabled
public void setNotificationEnabled(boolean isNotificationEnabled)(Code)
Specifies whether or not structure change listeners should be notified of structure changes.
Parameters:
  isNotificationEnabled - DOCUMENT ME!

setRecord
abstract public void setRecord(ReadAccessRecord record) throws StructureException(Code)
Sets the record of the recordables. Should throw a StructureException if the structure is not open, for example.
Parameters:
  record - the structure element to be stored
throws:
  StructureException - if an error has occurred

setRecordName
abstract public void setRecordName(String recordName)(Code)
Sets the name of the stored record.
Parameters:
  recordName - DOCUMENT ME!

setRootElement
abstract public void setRootElement(StructureElement root) throws StructureException(Code)
Set the root element of the structure. The root element and all its children will be saved in the extrana� structure. Should throw a StructureException if the structure is not open, for example.
Parameters:
  root - the root element of the structure that should be saved.
throws:
  StructureException - if an error has occurred

size
abstract public int size() throws StructureException(Code)
Returns the number of elements stored in the structure. DOCUMENT ME!
throws:
  StructureException - if an error has occurred

Fields inherited from jacareto.system.EnvironmentMember
protected Customization customization(Code)(Java Doc)
protected Environment env(Code)(Java Doc)
protected Files files(Code)(Java Doc)
protected Language language(Code)(Java Doc)
protected Logger logger(Code)(Java Doc)

Methods inherited from jacareto.system.EnvironmentMember
public Customization getCustomization()(Code)(Java Doc)
public Environment getEnvironment()(Code)(Java Doc)
public Files getFiles()(Code)(Java Doc)
public Language getLanguage()(Code)(Java Doc)
public Logger getLogger()(Code)(Java Doc)
public void setEnvironment(Environment env)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.