org.openptk.api
Class Input

java.lang.Object
  org.openptk.api.Element
      org.openptk.api.Input

All Implemented Interfaces:

ElementIF

public class Input
extends Element

The Input object is used "transport" data when an Operation is executed. The Input can contain:

• Unique Id
• Attributes
• Properties
• Query

Author:

Scott Fehrman, Sun Microsystems, Inc.

Constructor Summary

Input()
Creates a new Input oblect.

Input(Input input)
Create a new Input that is a copy of the specified Input.

Method Summary

static void	build(Input input, StructureIF struct) Populates the Input with Attributes from the StructureIF data.
Input	copy() Creates a "deep" copy of the Input.
AttributeIF.Access	getAccess() Get the Input's access level.
java.lang.String	getAccessAsString() Get the Input's access level, string representation.
Query	getQuery() Get the Input's Query.
void	removeQuery() Removes the Input's Query.
void	setAccess(AttributeIF.Access access) Set the Input's access level.
void	setAccess(java.lang.String val) Set the Input's access level.
void	setQuery(Query query) Set the Input's Query.

Methods inherited from class org.openptk.api.Element

addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttributes, getAttribute, getAttributeNames, getAttributes, getAttributesSize, getDescription, getKey, getProperties, getPropertiesSize, getProperty, getState, getStateAsString, getStatus, getUniqueId, getUniqueIdType, isError, removeAttribute, removeProperty, setAttributes, setDescription, setError, setKey, setProperties, setProperty, setState, setStatus, setUniqueId, setUniqueId, setUniqueId, setUniqueId, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Input

public Input()

Creates a new Input oblect.

Input

public Input(Input input)

Create a new Input that is a copy of the specified Input.

Parameters:

input - an existing Input

Method Detail

build

public static void build(Input input,
                         StructureIF struct)

Populates the Input with Attributes from the StructureIF data. For each child within the structure, a new Attribute is created using the child-structure's name and value information.

Parameters:

input - a non-null Input object

struct - a non-null SturctureIF object

copy

public Input copy()

Creates a "deep" copy of the Input.

Specified by:

copy in interface ElementIF

Overrides:

copy in class Element

Returns:

Input the new Input (a copy)

getAccess

public final AttributeIF.Access getAccess()

Get the Input's access level.

Returns:

AttributeIF.Access the access level

getAccessAsString

public final java.lang.String getAccessAsString()

Get the Input's access level, string representation.

Returns:

String the access level

getQuery

public final Query getQuery()

Get the Input's Query.

Returns:

Query the Query

removeQuery

public final void removeQuery()

Removes the Input's Query.

setAccess

public final void setAccess(AttributeIF.Access access)

Set the Input's access level.

Parameters:

access - the access level

setAccess

public final void setAccess(java.lang.String val)

Set the Input's access level.

Parameters:

val - the access level

setQuery

public final void setQuery(Query query)

Set the Input's Query.

Parameters:

query - a Query object