org.netbeans.modules.bpel.model.api
Interface BpelEntity

All Superinterfaces:
Component<BpelEntity>, DocumentComponent<BpelEntity>
All Known Subinterfaces:
Activity, ActivityHolder, AfterExtensions, AfterImport, AfterSources, AfterTargets, Alert, Assign, AssignChild, BaseCorrelation, BaseFaultHandlers, BaseScope, BooleanExpr, BpelContainer, BpelReferenceable, Branches, Catch, CatchAll, CompensatableActivityHolder, Compensate, CompensateScope, CompensationHandler, CompensationHandlerHolder, CompletionCondition, CompositeActivity, Condition, Copy, Correlation, CorrelationContainer, CorrelationSet, CorrelationSetContainer, CorrelationsHolder, DeadlineExpression, Documentation, DurationExpression, Else, ElseIf, Empty, EventHandlers, Exit, Expression, ExtendableActivity, ExtensibleAssign, ExtensibleElements, Extension, ExtensionActivity, ExtensionContainer, ExtensionEntity, FaultHandler, FaultHandlers, FinalCounterValue, Flow, For, ForEach, From, FromChild, FromPart, FromPartContainer, FromPartsHolder, If, Import, Invoke, Link, LinkContainer, Literal, Log, MessageExchange, MessageExchangeContainer, OnAlarmEvent, OnAlarmPick, OnEvent, OnMessage, OnMessageCommon, PartnerLink, PartnerLinkContainer, PatternedCorrelation, PatternedCorrelationContainer, Pick, Process, Query, Receive, RepeatEvery, RepeatUntil, Reply, ReThrow, Scope, Sequence, ServiceRef, Source, SourceContainer, StartCounterValue, Target, TargetContainer, TerminationHandler, Throw, TimeEvent, TimeEventHolder, To, ToPart, ToPartContainer, ToPartsHolder, Trace, Validate, Variable, VariableContainer, VariableDeclaration, VariableDeclarationScope, Wait, While
All Known Implementing Classes:
ActivityHolderImpl, ActivityImpl, AlertImpl, AssignImpl, BaseScopeImpl, BooleanExprImpl, BpelContainerImpl, BpelEntityImpl, BranchesImpl, CatchAllImpl, CatchImpl, CompensateImpl, CompensateScopeImpl, CompensationHandlerImpl, CompletionConditionImpl, CompositeActivityImpl, ConditionalActivity, ConditionImpl, CopyImpl, CorrelationContainerImpl, CorrelationImpl, CorrelationSetContainerImpl, CorrelationSetImpl, DeadlineExpressionImpl, DocumentationImpl, ElseIfImpl, ElseImpl, EmptyImpl, EventHandlersImpl, ExitImpl, ExpressionImpl, ExtensibleAssignImpl, ExtensibleElementsImpl, ExtensionActivityImpl, ExtensionContainerImpl, ExtensionImpl, FaultHandlersImpl, FinalCounterValueImpl, FlowImpl, ForEachImpl, ForImpl, FromHolderImpl, FromImpl, FromPartConainerImpl, FromPartImpl, IfImpl, ImportImpl, InvokeImpl, InvokeReceiveReplyCommonImpl, LinkContainerImpl, LinkImpl, LiteralImpl, LoggingEntityImpl, LogImpl, MessageExchangeContainerImpl, MessageExchangeImpl, NamedElementImpl, NamespaceSpecImpl, OnAlarmEventImpl, OnAlarmPickImpl, OnEventImpl, OnMessageCommonImpl, OnMessageImpl, PartnerLinkContainerImpl, PartnerLinkImpl, PatternedCorrelationContainerImpl, PatternedCorrelationImpl, PickImpl, ProcessImpl, QueryImpl, ReceiveImpl, RepeatEveryImpl, RepeatUntilImpl, ReplyImpl, ReplyReceiveIntersectImpl, ReThrowImpl, ScopeImpl, SequenceImpl, ServiceRefImpl, SourceContainerImpl, SourceImpl, StartCounterValueImpl, TargetContainerImpl, TargetImpl, TerminationHandlerImpl, ThrowImpl, ToFromIntersectImpl, ToImpl, ToPartContainerImpl, ToPartImpl, TraceImpl, ValidateImpl, VariableContainerImpl, VariableImpl, WaitImpl, WhileImpl

public interface BpelEntity
extends DocumentComponent<BpelEntity>

Marker interface. Any element in OM will implement this interface. One should use for keep reference to OM model element use BpelEement instead of Object.

Author:
ads

Field Summary
static java.lang.String BUSINESS_PROCESS_1_1_NS_URI
           
static java.lang.String BUSINESS_PROCESS_DRAFT_NS_URI
           
static java.lang.String BUSINESS_PROCESS_NS_URI
          Namespace uri for current BPEL spec.
 
Fields inherited from interface org.netbeans.modules.xml.xam.dom.DocumentComponent
TEXT_CONTENT_PROPERTY
 
Method Summary
 void accept(BpelModelVisitor visitor)
          This method will apply visitor to this OM element.
 void accept(SimpleBpelModelVisitor visitor)
          This method will apply visitor to each element in model starting from this.
 BpelEntity copy(java.util.HashMap<UniqueId,UniqueId> uniqueMap)
          Creates deep copy of OM element.
 BpelEntity cut()
          Returns element that is copy of this element.
 BpelModel getBpelModel()
          Accessor to model.
 java.lang.Object getCookie(java.lang.Object key)
          Returns stored object with given key that was previusly put into this entity via setCookie.
 java.lang.Class<? extends BpelEntity> getElementType()
           
 org.netbeans.modules.xml.xpath.ext.schema.ExNamespaceContext getNamespaceContext()
          Returns ExNamespaceContext context for this element.
 BpelContainer getParent()
          
 UniqueId getUID()
          Returns unique id of element in OM.
 void removeCookie(java.lang.Object key)
          Removes object with given key from cookies.
 void setCookie(java.lang.Object key, java.lang.Object obj)
          Set cookie for this entity.
 
Methods inherited from interface org.netbeans.modules.xml.xam.dom.DocumentComponent
findAttributePosition, findChildComponent, findPosition, getAttribute, getPeer, isInDocumentModel, referencesSameNode, setAttribute
 
Methods inherited from interface org.netbeans.modules.xml.xam.Component
canPaste, copy, getChildren, getChildren, getChildren, getModel
 

Field Detail

BUSINESS_PROCESS_NS_URI

static final java.lang.String BUSINESS_PROCESS_NS_URI
Namespace uri for current BPEL spec.

See Also:
Constant Field Values

BUSINESS_PROCESS_DRAFT_NS_URI

static final java.lang.String BUSINESS_PROCESS_DRAFT_NS_URI
See Also:
Constant Field Values

BUSINESS_PROCESS_1_1_NS_URI

static final java.lang.String BUSINESS_PROCESS_1_1_NS_URI
See Also:
Constant Field Values
Method Detail

getParent

BpelContainer getParent()

Specified by:
getParent in interface Component<BpelEntity>
Returns:
parent component.

getBpelModel

BpelModel getBpelModel()
Accessor to model. It should be used for getting reference to model instead of acccessing to root process ( process could be got from Model ). Note that this method returns always not null reference to model, even if component is deleted. It differs from getModel() method which return null in this case.

Returns:
bpel OM model.

getElementType

java.lang.Class<? extends BpelEntity> getElementType()
Returns:
interface in OM that represented by this entity.

copy

BpelEntity copy(java.util.HashMap<UniqueId,UniqueId> uniqueMap)
Creates deep copy of OM element. uniqueMap is used for storing correspondance between this element and return element. Uid of this copied element ( end each deep child ) will be null. After attaching element to OM it will have different uid . Cookies are not copied for copy element ( and any child ).

Parameters:
uniqueMap - map that will be used for filling unique ids.
Returns:
copy of this entity.

cut

BpelEntity cut()
Returns element that is copy of this element. This element and all its children will have the same unique ids. Original element ( this ) is removed from tree. Uid of this element ( and each child ) will be null. After pasting element into OM pasted element ( and its children respectively ) will have the same uid as original. After pasting element will be invalid and if you will use it for new pasting then it will be the same as pasting of copy ( see copy method ). All cookies from original element will be saved for cut element ( and any child ).

Returns:
copy of this entity that could be used for inserting in OM.

getUID

UniqueId getUID()
Returns unique id of element in OM. This uid will be null if element was created via factory ( BpelElementBuilder class ). Element could have not null uid even if it not in OM. This will be in case when it was copied or cut.

Returns:
unique id of this entity.

accept

void accept(SimpleBpelModelVisitor visitor)
This method will apply visitor to each element in model starting from this. visitor should not know nothing about OM tree structure. It means it should not perfrom navigation through children in "visit" method. Om element "accept" method will apply visitor to any child itself.

Parameters:
visitor - visitor for OM.

accept

void accept(BpelModelVisitor visitor)
This method will apply visitor to this OM element. visitor should perform navigation in tree ( if it wants by itself ).

Parameters:
visitor - visitor for OM.

getNamespaceContext

org.netbeans.modules.xml.xpath.ext.schema.ExNamespaceContext getNamespaceContext()
Returns ExNamespaceContext context for this element. This context can be used for retrieving prefixes by uri, uri by prefixes.

Returns:
namespace context object.

getCookie

java.lang.Object getCookie(java.lang.Object key)
Returns stored object with given key that was previusly put into this entity via setCookie.

Parameters:
key - key for cookie retrieveing
Returns:
object that stored as cookie identified by key.

setCookie

void setCookie(java.lang.Object key,
               java.lang.Object obj)
Set cookie for this entity.

Parameters:
key - key for cookie.
obj - any object that we want to store here.

removeCookie

void removeCookie(java.lang.Object key)
Removes object with given key from cookies.

Parameters:
key - key of object that we want to remove from cookies.