Java Doc for ControllerElement.java in » J2EE » Expresso » com » jcorporate » expresso » core » controller » 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 » J2EE » Expresso » com.jcorporate.expresso.core.controller

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

com.jcorporate.expresso.core.controller .ControllerElement

All known Subclasses:   com.jcorporate.expresso.core.controller .Block,  com.jcorporate.expresso.core.controller .Input,  com.jcorporate.expresso.core.controller .Transition,  com.jcorporate.expresso.core.controller .Output,
ControllerElement
public class ControllerElement implements Cloneable,java.io.Serializable(Code)
A ControllerElement is the superclass for the three types of objects that are produced by a Controller when it transitions from one state to another. Output, Input and Transition objects all extend this class, and share the behaviors specified here. IMPORTANT NOTE: We don't use Logging (e.g. log4j) in this object, as it is sometimes stored in session when the server shuts down, and must be able to re-instantiate from the serialized form without needing to wait for ConfigManager to be initialized.

Constructor Summary
protected ControllerElement()


Method Summary
public void addNested(ControllerElement e)

public Vector allNested()

public Object clone()
     Shouldn't be normally called directly.
public static ControllerElement fromXML(Node n)
     Base Class 'deserialization' from XML given a DOM Node N.
Parameters:
  n - A DOM Node object.
protected static ControllerElement fromXML(Node n, ControllerElement ce)

public String getAttribute(String att)
     Get the value of an "attribute" for this ControllerElement item.
public HashMap getAttributes()

public HashMap getAttributesOrNull()
     Same as above but will return null if no attributes have ever been set.
public ControllerElement getContent(String name)

public Vector getContents()

protected ControllerResponse getControllerResponse()

public String getDescription()

public int getDisplayLength()
     Get the display length suggested by the controller for this item.
public String getLabel()

public int getLines()

public String getName()
     Get the name of this element.
public Vector getNested()

public ControllerElement getNested(String nestedName)

public int getNestedCount()
     A method to support JSTL 1.0 usage; returns the size of the nested controller elements.

In JSTL 1.0 it is not possible to the retrieve sizes of collections directly without using a wrapper or a custom tag action.
public Iterator getNestedIterator()
     Retrieve the iterator to all tested objects.
public Map getNestedMap()
     Return a Map of all nested elements keyed by controllerElement name.
public Vector getNestedOrNull()
     Same as getNested.
public ControllerElement getParent()
     Return the "parent" of this element - e.g.
public String getTitle()
     Get the name of this element.
public String getType()

public void remove()
     Remove this item from the "nested" items of it's parent.
public void removeNested(ControllerElement elementToRemove)

public void setAttribute(String attrib, String val)

public synchronized void setControllerResponse(ControllerResponse newResponse)

public void setDescription(String newDescription)

public void setDisplayLength(int newLength)

public void setLabel(String newLabel)

public void setLines(int newLines)

public void setName(String newName)

public void setParent(ControllerElement t)
     Set the "parent" of this element - e.g.
public void setType(String s)

public FastStringBuffer toXML(FastStringBuffer stream)
     Convert the object to an xml fragment.

Constructor Detail
ControllerElement
protected ControllerElement()(Code)
Default constructor

Method Detail
addNested
public void addNested(ControllerElement e)(Code)
Add a nested item to this element
Parameters:
  e - A ControllerElement to nest inside this element

allNested
public Vector allNested()(Code)
Return the nested items from this item java.util.Vector

clone
public Object clone() throws java.lang.CloneNotSupportedException(Code)
Shouldn't be normally called directly. created or null of the creation fails.
throws:
  CloneNotSupportedException - as per the API spec.

fromXML
public static ControllerElement fromXML(Node n) throws ControllerException(Code)
Base Class 'deserialization' from XML given a DOM Node N.
Parameters:
  n - A DOM Node object. an instantiated ControllerElement

fromXML
protected static ControllerElement fromXML(Node n, ControllerElement ce) throws ControllerException(Code)
Return a controller element based upon the xml fragment
Parameters:
  n - The DOM node that represents the controller-element
Parameters:
  ce - The created controller element subclass an instantiated ControllerElement
throws:
  ControllerException - if fragment is not a controller element

getAttribute
public String getAttribute(String att)(Code)
Get the value of an "attribute" for this ControllerElement item. The attributes can be any set of named values that the client and Controller are both aware of.
Parameters:
  att - The name of the attribute whose value is wanted The value of the specified attribtue, if it exists, elsenull

getAttributes
public HashMap getAttributes()(Code)
Return the entire Hashtable of attribute values for this ControllerElement A Hashtable of name/value pairs for this ControllerElement object

getAttributesOrNull
public HashMap getAttributesOrNull()(Code)
Same as above but will return null if no attributes have ever been set. HashMap or null

getContent
public ControllerElement getContent(String name)(Code)

getContents
public Vector getContents()(Code)
Returns the contents of this controller element Vector of nested content

getControllerResponse
protected ControllerResponse getControllerResponse()(Code)

getDescription
public String getDescription()(Code)
Get the description of this element A String description of this element as specified by thecontroller

getDisplayLength
public int getDisplayLength()(Code)
Get the display length suggested by the controller for this item. The display length suggested for this item

getLabel
public String getLabel()(Code)
Get the label of this element The label of this element

getLines
public int getLines()(Code)
Get the suggested number of lines for this item integer

getName
public String getName()(Code)
Get the name of this element. title and name are synonymous--easier for JSTL The name of this element

getNested
public Vector getNested()(Code)
Return the entire Vector of nested elements in this element A Vector of the objects nested within this element

getNested
public ControllerElement getNested(String nestedName) throws ControllerException(Code)
Return a specific Element nested within this Element
Parameters:
  nestedName - the name of the element to retrieve An Element with the specified name or null if it doesn't exist

getNestedCount
public int getNestedCount()(Code)
A method to support JSTL 1.0 usage; returns the size of the nested controller elements.

In JSTL 1.0 it is not possible to the retrieve sizes of collections directly without using a wrapper or a custom tag action.
size of all nested controller elements

getNestedIterator
public Iterator getNestedIterator()(Code)
Retrieve the iterator to all tested objects.

getNestedMap
public Map getNestedMap()(Code)
Return a Map of all nested elements keyed by controllerElement name. Useful for JSTL iteration of the Map.

getNestedOrNull
public Vector getNestedOrNull()(Code)
Same as getNested. But does not allocate a Vector if there aren't any values. java.util.Vector or null if nested Vector doesn't exist yet.

getParent
public ControllerElement getParent()(Code)
Return the "parent" of this element - e.g. the element that this element is nested within the parent element or possibly null if there is no parent

getTitle
public String getTitle()(Code)
Get the name of this element. title and name are synonymous--easier for JSTL The name of this element

getType
public String getType()(Code)
Returns whatever the type is java.lang.String

remove
public void remove() throws ControllerException(Code)
Remove this item from the "nested" items of it's parent. After this method, the item is still valid, but is no longer nested within it's parent
throws:
  ControllerException - if the current item is not nested

removeNested
public void removeNested(ControllerElement elementToRemove) throws ControllerException(Code)
Remove an element from the nested elements for this item
Parameters:
  elementToRemove - The element to be removed from the list ofnested items.
throws:
  ControllerException - if there is no such item nested in this item

setAttribute
public void setAttribute(String attrib, String val)(Code)
Set the named attribute of this Output to the given value
Parameters:
  attrib - The name of an "attribtue" for this ControllerElement item
Parameters:
  val - The value for this attribute

setControllerResponse
public synchronized void setControllerResponse(ControllerResponse newResponse)(Code)
Called by the ControllerResponse to hand itself back to this element so that it can be accessed by the elements as required
Parameters:
  newResponse - the new Response.

setDescription
public void setDescription(String newDescription)(Code)
Used by the controller to set the description of this element
Parameters:
  newDescription - The description being set by this object

setDisplayLength
public void setDisplayLength(int newLength)(Code)
Set the suggested display length (in caracters) for this Controller element
Parameters:
  newLength - The specified length for display of this element

setLabel
public void setLabel(String newLabel)(Code)
Set a label for this element
Parameters:
  newLabel - The new label for this element

setLines
public void setLines(int newLines)(Code)
Set the display number of lines suggested for this item
Parameters:
  newLines - The number of lines to specify

setName
public void setName(String newName)(Code)
Used by the controller to set the name of this element
Parameters:
  newName - The new name for this element

setParent
public void setParent(ControllerElement t)(Code)
Set the "parent" of this element - e.g. the element that this element is nested within
Parameters:
  t - The ControllerElement that has this element as a nested item

setType
public void setType(String s)(Code)
Sets the descriptive data type for this ControllerElement
Parameters:
  s - a new java.lang.String

toXML
public FastStringBuffer toXML(FastStringBuffer stream)(Code)
Convert the object to an xml fragment.
Parameters:
  stream - a pre-allocated FastStringBuffer to append to the in parameter stream.

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.