Package org.bigraphs.framework.core.impl.signature

Class KindSignatureBuilder

java.lang.Object

org.bigraphs.framework.core.SignatureBuilder<StringTypedName,FiniteOrdinal<Integer>,KindControlBuilder,KindSignatureBuilder>

org.bigraphs.framework.core.impl.signature.KindSignatureBuilder

public class KindSignatureBuilder
extends SignatureBuilder<StringTypedName,FiniteOrdinal<Integer>,KindControlBuilder,KindSignatureBuilder>

Builder for kind signatures.

Typical usage relies on methods such as addControl, getControl, or addActiveKindSort.

Author:

Dominik Grzelak

Constructor Summary

Constructors

Constructor	Description
KindSignatureBuilder()

Method Summary

Modifier and Type	Method	Description
KindSignatureBuilder	addActiveKindSort(String control, Collection<String> containingControls)	This methods adds a place-sort for the given control.
KindSignatureBuilder	addControl(String name, int arity)
KindSignatureBuilder	addPassiveKindSort(String control)	This method adds an empty place-sort for the given control.
KindSignature	create()	Create the signature with the assigned controls so far.
KindSignature	create(EMetaModelData metaModelData)
protected KindControlBuilder	createControlBuilder()	Hook method to be implemented by subclasses for creating the corresponding control builder (i.e., only active or dynamic controls).
KindSignature	createEmpty()	Creates an empty signature, meaning that the control set is empty. Needed for the interaction of elementary bigraphs and user-defined bigraphs.
protected KindSignature	createEmptyStub()	This method is not called by the user; it is called by SignatureBuilder.createEmpty().
KindSignature	createWith(Iterable<? extends Control<StringTypedName,FiniteOrdinal<Integer>>> controls)	Create a signature with the given controls.
KindSignature	createWith(Iterable<? extends Control<StringTypedName,FiniteOrdinal<Integer>>> controls, Collection<KindSort> kindSorts)
KindSignature	createWith(Iterable<? extends Control<StringTypedName,FiniteOrdinal<Integer>>> controls, Collection<KindSort> kindSorts, EMetaModelData metaModelData)
KindControlBuilder	newControl(String name, int arity)

Methods inherited from class org.bigraphs.framework.core.SignatureBuilder

add, getControls, newControl, newControl, self

Methods inherited from class java.lang.Object

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

Constructor Details

KindSignatureBuilder

public KindSignatureBuilder()

Method Details

createControlBuilder

protected KindControlBuilder createControlBuilder()

Description copied from class: SignatureBuilder

Hook method to be implemented by subclasses for creating the corresponding control builder (i.e., only active or dynamic controls).

Specified by:

createControlBuilder in class SignatureBuilder<StringTypedName,FiniteOrdinal<Integer>,KindControlBuilder,KindSignatureBuilder>

Returns:

the control builder

newControl

public KindControlBuilder newControl(String name,
 int arity)

addControl

public KindSignatureBuilder addControl(String name,
 int arity)

addActiveKindSort

public KindSignatureBuilder addActiveKindSort(String control,
 Collection<String> containingControls)
                                       throws ControlNotExistsException

This methods adds a place-sort for the given control. The status of the control is thus active, i.e., it is an non-atomic control.

If this method is called multiple times with the same argument control, the new values containingControls will be used to override the existing sorting for the control control.

If this method is called after, for example, addPassiveKindSort(String), then it will override the previous configuration of being an atomic control.

Parameters:

control - the control to specify the place-sorts for

containingControls - the controls that can be nested under control

Returns:

the same instance of the kind signature builder

Throws:

ControlNotExistsException

addPassiveKindSort

public KindSignatureBuilder addPassiveKindSort(String control)
                                        throws ControlNotExistsException

This method adds an empty place-sort for the given control. The status of the control is thus passive, i.e., it is an atomic control.

If this method is called after, for example, addActiveKindSort(String, Collection), then it will override the existing sort and declare the given control as passive.

Parameters:

control - the control to declare atomic

Returns:

Throws:

ControlNotExistsException

create

public KindSignature create()

Description copied from class: SignatureBuilder

Create the signature with the assigned controls so far.

Overrides:

create in class SignatureBuilder<StringTypedName,FiniteOrdinal<Integer>,KindControlBuilder,KindSignatureBuilder>

Returns:

a signature

create

public KindSignature create(EMetaModelData metaModelData)

Overrides:

create in class SignatureBuilder<StringTypedName,FiniteOrdinal<Integer>,KindControlBuilder,KindSignatureBuilder>

createWith

public KindSignature createWith(Iterable<? extends Control<StringTypedName,FiniteOrdinal<Integer>>> controls)

Description copied from class: SignatureBuilder

Create a signature with the given controls.

Specified by:

createWith in class SignatureBuilder<StringTypedName,FiniteOrdinal<Integer>,KindControlBuilder,KindSignatureBuilder>

Parameters:

controls - the controls to use for the signature

Returns:

a signature with the given controls

createWith

public KindSignature createWith(Iterable<? extends Control<StringTypedName,FiniteOrdinal<Integer>>> controls,
 Collection<KindSort> kindSorts)

createWith

public KindSignature createWith(Iterable<? extends Control<StringTypedName,FiniteOrdinal<Integer>>> controls,
 Collection<KindSort> kindSorts,
 EMetaModelData metaModelData)

createEmpty

public KindSignature createEmpty()

Description copied from class: SignatureBuilder

Creates an empty signature, meaning that the control set is empty.
Needed for the interaction of elementary bigraphs and user-defined bigraphs.

Overrides:

createEmpty in class SignatureBuilder<StringTypedName,FiniteOrdinal<Integer>,KindControlBuilder,KindSignatureBuilder>

Returns:

an empty signature of type <S>.

createEmptyStub

protected KindSignature createEmptyStub()

Description copied from class: SignatureBuilder

This method is not called by the user; it is called by SignatureBuilder.createEmpty().

Specified by:

createEmptyStub in class SignatureBuilder<StringTypedName,FiniteOrdinal<Integer>,KindControlBuilder,KindSignatureBuilder>