org.obe.xpdl.model.misc
Class ExtendedAttributes

java.lang.Object
  extended byorg.obe.util.AbstractBean
      extended byorg.obe.xpdl.model.data.XMLFragment
          extended byorg.obe.xpdl.model.misc.ExtendedAttributes
All Implemented Interfaces:
java.beans.beancontext.BeanContextChild, java.io.Serializable

public final class ExtendedAttributes
extends XMLFragment

Holds 3rd party extended attributes as XML text. The text must include the <ExtendedAttributes> parent element, correctly declared in the XPDL namespace.

N.B. DO NOT USE THIS CLASS FOR STORING OBE EXTENDED ATTRIBUTES!

Author:
Adrian Price
See Also:
XPDLNames.XPDL_NS_PREFIX, XPDLNames.XPDL_NS_URI, ResourceContainer.setAssignmentStrategy(AssignmentStrategyDef), ResourceContainer.setAssignmentStrategy(AssignmentStrategyDef), Activity.setAssignmentStrategy(AssignmentStrategyDef), XPDLPackage.setCompletionStrategy(String), WorkflowProcess.setCompletionStrategy(String), Activity.setCompletionStrategy(String), ResourceContainer.setCalendar(String), ResourceContainer.setCalendar(String), Activity.setCalendar(String), Transition.setExecutionType(ExecutionType), Transition.setEvent(Event), BlockActivity.setLoop(Loop), Serialized Form

Field Summary
 
Fields inherited from class org.obe.xpdl.model.data.XMLFragment
MAX_TOSTRING_TEXT_LEN
 
Constructor Summary
ExtendedAttributes()
           
ExtendedAttributes(org.w3c.dom.Document document)
           
ExtendedAttributes(java.util.Map map)
           
ExtendedAttributes(java.lang.String text)
           
 
Method Summary
 void clear()
           
 java.lang.String get(java.lang.String key)
           
protected  java.lang.String getDocumentElementName()
          Returns the unqualified name of the required document element.
protected  java.lang.String getDocumentElementNamespaceURI()
          Returns the required document element namespace URI.
 java.util.Map getMap()
          Returns an unmodifiable map of name:value pairs.
 void put(java.lang.String key, java.lang.Object value)
           
 void remove(java.lang.String key)
           
 void setMap(java.util.Map map)
          Sets extended attributes as map of name:value pairs.
 
Methods inherited from class org.obe.xpdl.model.data.XMLFragment
equals, getDocument, getText, hashCode, setDocument, setText, toString
 
Methods inherited from class org.obe.util.AbstractBean
add, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, clear, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, get, get, getBeanContext, getListModel, hasChangeListeners, hasVetoListeners, remove, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener, set, set, setBeanContext
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ExtendedAttributes

public ExtendedAttributes()

ExtendedAttributes

public ExtendedAttributes(java.lang.String text)
                   throws XMLException

ExtendedAttributes

public ExtendedAttributes(org.w3c.dom.Document document)
                   throws XMLException

ExtendedAttributes

public ExtendedAttributes(java.util.Map map)
                   throws XMLException
Method Detail

getDocumentElementName

protected java.lang.String getDocumentElementName()
Description copied from class: XMLFragment
Returns the unqualified name of the required document element.

Specified by:
getDocumentElementName in class XMLFragment
Returns:
Unqualified element name.

getDocumentElementNamespaceURI

protected java.lang.String getDocumentElementNamespaceURI()
Description copied from class: XMLFragment
Returns the required document element namespace URI.

Specified by:
getDocumentElementNamespaceURI in class XMLFragment
Returns:
Required namespace URI.

clear

public void clear()
           throws XMLException
Throws:
XMLException

get

public java.lang.String get(java.lang.String key)
                     throws XMLException
Throws:
XMLException

put

public void put(java.lang.String key,
                java.lang.Object value)
         throws XMLException
Throws:
XMLException

remove

public void remove(java.lang.String key)
            throws XMLException
Throws:
XMLException

getMap

public java.util.Map getMap()
                     throws XMLException
Returns an unmodifiable map of name:value pairs. The map representation is only suitable for simple extended attributes with values that can be represented as strings.

Returns:
A map of simple name:value pairs.
Throws:
XMLException

setMap

public void setMap(java.util.Map map)
            throws XMLException
Sets extended attributes as map of name:value pairs. The map representation is only suitable for simple extended attributes with values that can be represented as strings. Complex extended attributes must be set either as XML text or as a DOM document; in either case the document element must be ExtendedAttributes, in the XPDL namspace URI http://www.wfmc.org/2002/XPDL1.0.

Parameters:
map - Map of name:value pairs.
Throws:
XMLException


SourceForge.net Logo OBE-1.0 Copyright (C) 2002-2006 Adrian Price. All Rights Reserved.