org.jbpt.bp

Class RelSet<M,N extends IEntity>

java.lang.Object

org.jbpt.bp.RelSet<M,N>

All Implemented Interfaces:

IEntityModel<N>

Direct Known Subclasses:

BehaviouralProfile

public class RelSet<M,N extends IEntity>
extends Object
implements IEntityModel<N>

Field Summary

Fields

Modifier and Type	Field and Description
protected List<N>	entities The relations are defined over a dedicated set of entities of the model, e.g., only transitions of a Petri net or only labelled transitions of a Petri net.
protected int	lookAhead
protected RelSetType[][]	matrix The matrix that captures the actual relations for the Cartesian product of the respective entities.
protected M	model The model (e.g., Petri net) for which this class captures the set of behavioural relations.
static int	RELATION_FAR_LOOKAHEAD

Constructor Summary

Constructors

Constructor and Description
RelSet(int size) Creates a relation set for a given number of entities.
RelSet(M model, Collection<N> entities) Creates a relation set for a given model and a dedicated collection of entities of the model.
RelSet(M model, Collection<N> entities, int lookAhead)
RelSet(M model, List<N> entities) Creates a relation set for a given model and a dedicated list of entities of the model.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	areExclusive(N n1, N n2) Checks whether two given entities are exclusive.
boolean	areInOrder(N n1, N n2) Checks whether two given entities are ordered.
boolean	areInterleaving(N n1, N n2) Checks whether two given entities are interleaving.
boolean	equals(RelSet<M,N> relationSet) Checks equality for two relation sets.
boolean	equalsForSharedEntities(RelSet<M,N> relationSet) Checks equality for two relation sets only for the shared entities.
RelSet<M,N>	getComplement() Returns the complement of the relation set .
static RelSetType	getComplementRelation(RelSetType rel) Returns the complementary relation for a relation.
List<N>	getEntities()
Collection<N>	getEntitiesInRelation(N n, RelSetType relationType) Returns all entities that are in a given behavioural relation with a given entity.
int	getLookAhead()
RelSetType[][]	getMatrix()
M	getModel()
RelSetType	getRelationForEntities(N n1, N n2) Returns the behavioural relation for two given entities.
RelSetType	getRelationForIndex(int index1, int index2) Returns the type of the behavioural relation for the two entities that are identified by their index in the list of entities for which the relation set is defined.
HashMap<RelSetType,HashSet<String>>	getRelationsByType(Set<RelSetType> relationTypes)
static RelSetType	getReverseRelation(RelSetType rel) Returns the reverse relation for a relation, if defined.
static String	getSymbolForRelation(RelSetType rel) Returns a short string representation for a behavioural relation.
boolean	isEmpty() Checks emptiness of a relation set.
void	printAllEntities(RelSetType relationType) Dumps all entities in a given behavioural relation to the standard output.
void	setLookAhead(int lookAhead)
void	setMatrix(RelSetType[][] matrix)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

RELATION_FAR_LOOKAHEAD

public static final int RELATION_FAR_LOOKAHEAD

See Also:

Constant Field Values

lookAhead

protected int lookAhead

model

protected M model

The model (e.g., Petri net) for which this class captures the set of behavioural relations.

entities

protected List<N extends IEntity> entities

The relations are defined over a dedicated set of entities of the model, e.g., only transitions of a Petri net or only labelled transitions of a Petri net. This list defines the respective entities.

matrix

protected RelSetType[][] matrix

The matrix that captures the actual relations for the Cartesian product of the respective entities.

Constructor Detail

RelSet

public RelSet(M model,
      List<N> entities)

Creates a relation set for a given model and a dedicated list of entities of the model.

Parameters:

model, - a model

entities, - a list of entities of the model

RelSet

public RelSet(M model,
      Collection<N> entities)

Creates a relation set for a given model and a dedicated collection of entities of the model. Wrapper method that creates a list from the given collection.

Parameters:

model, - a model

entities, - a list of entities of the model

RelSet

public RelSet(M model,
      Collection<N> entities,
      int lookAhead)

RelSet

public RelSet(int size)

Creates a relation set for a given number of entities. Use this constructor solely in case a relation set that is not related to a specific model is needed.

Parameters:

size, - i.e., number of entities over which the relations are defined

Method Detail

getReverseRelation

public static RelSetType getReverseRelation(RelSetType rel)

Returns the reverse relation for a relation, if defined. A reverse relation is defined solely for the order relations. Order -> Reverse order Reverse order -> order

Parameters:

relation - type

Returns:

type of the reverse relation, if defined, type of the original relation, else

getComplementRelation

public static RelSetType getComplementRelation(RelSetType rel)

Returns the complementary relation for a relation. The complement relation is defined according to the strictness hierarchy of relations: Order -> Reverse order Reverse order -> Order Exclusiveness -> Interleaving Interleaving -> Exclusiveness

Parameters:

relation - type

Returns:

type of the complement relation

getMatrix

public RelSetType[][] getMatrix()

setMatrix

public void setMatrix(RelSetType[][] matrix)

getEntities

public List<N> getEntities()

Specified by:

getEntities in interface IEntityModel<N extends IEntity>

getModel

public M getModel()

getLookAhead

public int getLookAhead()

setLookAhead

public void setLookAhead(int lookAhead)

getSymbolForRelation

public static String getSymbolForRelation(RelSetType rel)

Returns a short string representation for a behavioural relation.

Parameters:

type - of the behavioural relation

Returns:

string representation for a behavioural relation

areInterleaving

public boolean areInterleaving(N n1,
                      N n2)

Checks whether two given entities are interleaving.

Parameters:

n1 -

n2 -

Returns:

true, if both entities are interleaving

areExclusive

public boolean areExclusive(N n1,
                   N n2)

Checks whether two given entities are exclusive.

Parameters:

n1 -

n2 -

Returns:

true, if both entities are exclusive

areInOrder

public boolean areInOrder(N n1,
                 N n2)

Checks whether two given entities are ordered.

Parameters:

n1 -

n2 -

Returns:

true, if both entities are ordered

getRelationForEntities

public RelSetType getRelationForEntities(N n1,
                                N n2)

Returns the behavioural relation for two given entities.

Parameters:

n1 -

n2 -

Returns:

the relation of the behavioural profile for the entities

getRelationForIndex

public RelSetType getRelationForIndex(int index1,
                             int index2)

Returns the type of the behavioural relation for the two entities that are identified by their index in the list of entities for which the relation set is defined.

Parameters:

index1 -

index2 -

Returns:

the relation type of the relation set for the entities identified by the indices

getEntitiesInRelation

public Collection<N> getEntitiesInRelation(N n,
                                  RelSetType relationType)

Returns all entities that are in a given behavioural relation with a given entity.

Parameters:

an - entity

a - behavioural relation type

Returns:

all entities in the respective behavioural relation with the given entity

printAllEntities

public void printAllEntities(RelSetType relationType)

Dumps all entities in a given behavioural relation to the standard output.

Parameters:

a - behavioural relation type

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(RelSet<M,N> relationSet)

Checks equality for two relation sets. Returns false, if both matrices are not based on the same model or on the same set of entities.

Parameters:

profile - that should be compared

Returns:

true, if the given relation set is equivalent to this relation set

equalsForSharedEntities

public boolean equalsForSharedEntities(RelSet<M,N> relationSet)

Checks equality for two relation sets only for the shared entities. That is, we assess whether the structures define equal relations for all entities for which both structures are defined. Returns false, if both matrices are not based on the same model.

Parameters:

profile - that should be compared

Returns:

true, if the given relation set is equivalent to this relation set for shared entities

isEmpty

public boolean isEmpty()

Checks emptiness of a relation set. It is empty, if it defines exclusiveness for all pairs of entities.

Returns:

true, if the relation set is empty

getComplement

public RelSet<M,N> getComplement()

Returns the complement of the relation set . It is defined as the relation set that comprises the complement relations for all pairs of entities.

Returns:

getRelationsByType

public HashMap<RelSetType,HashSet<String>> getRelationsByType(Set<RelSetType> relationTypes)