org.btrplace.model

Interface Model

All Superinterfaces:

Cloneable, ElementBuilder

All Known Implementing Classes:

DefaultModel, SubModel

public interface Model
extends Cloneable, ElementBuilder

A model depicts a consistent snapshot of an infrastructure. Basically, a model is composed by a Mapping to indicate the state and the location of the elements, and a variety of ModelView to provide additional data about the elements.

In addition, it is possible to declare attributes for specific elements.

Author:

Fabien Hermenier

Method Summary

Modifier and Type	Method and Description
boolean	attach(ModelView v) Attach a view to the model.
void	clearViews() Detach all the views from this model.
Model	clone() Clone a model.
boolean	detach(ModelView v) Detach a view from this model.
Attributes	getAttributes() Get the attributes of the elements in the model.
Mapping	getMapping() Get the mapping associated to this model.
ModelView	getView(String id) Get a view already attached to the model
Collection<ModelView>	getViews() Get all the view attached to the model.
void	setAttributes(Attributes attrs) Set the attributes for the elements in the model.

Methods inherited from interface org.btrplace.model.ElementBuilder

contains, contains, newNode, newNode, newVM, newVM

Method Detail

getView

ModelView getView(String id)

Get a view already attached to the model

Parameters:

id - the view identifier

Returns:

the view if it was attached, null otherwise

getViews

Collection<ModelView> getViews()

Get all the view attached to the model.

Returns:

a collection of views that may be empty.

attach

boolean attach(ModelView v)

Attach a view to the model. No view with the same identifier must have been attached earlier.

Parameters:

v - the view to attach

Returns:

true iff the view has been attached

detach

boolean detach(ModelView v)

Detach a view from this model.

Parameters:

v - the view

Returns:

true iff the view was removed

clearViews

void clearViews()

Detach all the views from this model.

getMapping

Mapping getMapping()

Get the mapping associated to this model.

Returns:

the mapping

getAttributes

Attributes getAttributes()

Get the attributes of the elements in the model.

Returns:

the attributes

setAttributes

void setAttributes(Attributes attrs)

Set the attributes for the elements in the model.

Parameters:

attrs - the attributes to set

clone

Model clone()

Clone a model.

Specified by:

clone in interface ElementBuilder

Returns:

a new model