org.btrplace.model

Class SubModel

java.lang.Object

org.btrplace.model.SubModel

All Implemented Interfaces:

Cloneable, ElementBuilder, Model

public class SubModel
extends Object
implements Model

Define a model that is a sub-model of a bigger one. The operation on a sub-model are limited to the elements that belong to the given scope.

• Elements created in a sub-model are integrated automatically into the parent component
• It is not allowed to attach/detach/clear views
• It is not possible to set the attributes

Author:

Fabien Hermenier

Constructor Summary

Constructors

Constructor and Description
SubModel(Model p, ElementBuilder b, Collection<Node> ns) Make a new sub-model with an empty scope for ready VMs.
SubModel(Model p, ElementBuilder b, Collection<Node> nodeScope, Set<VM> vmReady) Make a new sub-model.

Method Summary

Modifier and Type	Method and Description
boolean	attach(ModelView v) Unsupported.
void	clearViews() Unsupported.
Model	clone() Clone this model using a DefaultModel.
boolean	contains(Node n) Check if a given node has been defined for this model.
boolean	contains(VM v) Check if a given VM has been defined for this model.
boolean	detach(ModelView v) Unsupported.
boolean	equals(Object o)
Attributes	getAttributes() Get the attributes of the elements in the model.
SubMapping	getMapping() Get a mapping that is limited to the given scope.
Collection<Node>	getScope() Get the scope of the model.
ModelView	getView(String id) Get a view already attached to the model
Collection<ModelView>	getViews() Get all the view attached to the model.
int	hashCode()
Node	newNode() Generate a new Node for this model.
Node	newNode(int id) Generate a new node for this model.
VM	newVM() Generate a new VM.
VM	newVM(int id) Generate a new VM.
void	setAttributes(Attributes attrs) Unsupported.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SubModel

public SubModel(Model p,
                ElementBuilder b,
                Collection<Node> ns)

Make a new sub-model with an empty scope for ready VMs.

Parameters:

p - the parent model

b - the element builder to rely on

ns - the node to restrict the model on.

SubModel

public SubModel(Model p,
                ElementBuilder b,
                Collection<Node> nodeScope,
                Set<VM> vmReady)

Make a new sub-model.

Parameters:

p - the parent model

b - the element builder to rely on

nodeScope - the node to restrict the model on.

vmReady - the scope of VMs that are ready in the parent model.

Method Detail

getScope

public Collection<Node> getScope()

Get the scope of the model.

Returns:

a set of nodes

getView

public ModelView getView(String id)

Description copied from interface: Model

Get a view already attached to the model

Specified by:

getView in interface Model

Parameters:

id - the view identifier

Returns:

the view if it was attached, null otherwise

getViews

public Collection<ModelView> getViews()

Description copied from interface: Model

Get all the view attached to the model.

Specified by:

getViews in interface Model

Returns:

a collection of views that may be empty.

attach

public boolean attach(ModelView v)

Unsupported.

Specified by:

attach in interface Model

Parameters:

v - the view to attach

Returns:

true iff the view has been attached

detach

public boolean detach(ModelView v)

Unsupported.

Specified by:

detach in interface Model

Parameters:

v - the view

Returns:

true iff the view was removed

clearViews

public void clearViews()

Unsupported.

Specified by:

clearViews in interface Model

getMapping

public SubMapping getMapping()

Get a mapping that is limited to the given scope.

Specified by:

getMapping in interface Model

Returns:

a mapping

getAttributes

public Attributes getAttributes()

Description copied from interface: Model

Get the attributes of the elements in the model.

Specified by:

getAttributes in interface Model

Returns:

the attributes

setAttributes

public void setAttributes(Attributes attrs)

Unsupported.

Specified by:

setAttributes in interface Model

Parameters:

attrs - the attributes to set

clone

public Model clone()

Clone this model using a DefaultModel.

Specified by:

clone in interface ElementBuilder

Specified by:

clone in interface Model

Overrides:

clone in class Object

Returns:

a mutable clone

newVM

public VM newVM()

Description copied from interface: ElementBuilder

Generate a new VM.

Specified by:

newVM in interface ElementBuilder

Returns:

null if no identifiers are available for the VM.

newVM

public VM newVM(int id)

Description copied from interface: ElementBuilder

Generate a new VM.

Specified by:

newVM in interface ElementBuilder

Parameters:

id - the identifier to use for that VM

Returns:

a VM or null if the identifier is already used

newNode

public Node newNode()

Description copied from interface: ElementBuilder

Generate a new Node for this model. The node will not be included in the mapping associated to the model.

Specified by:

newNode in interface ElementBuilder

Returns:

null if no identifiers are available for the Node.

newNode

public Node newNode(int id)

Description copied from interface: ElementBuilder

Generate a new node for this model. The node will not be included in the mapping associated to the model.

Specified by:

newNode in interface ElementBuilder

Parameters:

id - the identifier to use for that node

Returns:

a Node or null if the identifier is already used

contains

public boolean contains(VM v)

Description copied from interface: ElementBuilder

Check if a given VM has been defined for this model.

Specified by:

contains in interface ElementBuilder

Parameters:

v - the VM to check

Returns:

true iff the VM is already defined

contains

public boolean contains(Node n)

Description copied from interface: ElementBuilder

Check if a given node has been defined for this model.

Specified by:

contains in interface ElementBuilder

Parameters:

n - the node to check

Returns:

true iff the VM is booked

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object