org.jbpt.petri

Class AbstractPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

java.lang.Object

org.jbpt.hypergraph.abs.GObject

org.jbpt.hypergraph.abs.AbstractGraphNotifier<E,V>

org.jbpt.hypergraph.abs.AbstractMultiHyperGraph<E,V>

org.jbpt.hypergraph.abs.AbstractMultiDirectedHyperGraph<E,V>

org.jbpt.graph.abs.AbstractMultiDirectedGraph<E,V>

org.jbpt.graph.abs.AbstractDirectedGraph<F,N>

org.jbpt.petri.AbstractPetriNet<F,N,P,T>

All Implemented Interfaces:

Cloneable, Comparable<IGObject>, IDirectedGraph<F,N>, IGraph<F,N>, IDirectedHyperGraph<F,N>, IEntity, IEntityModel<N>, IGObject, IHyperGraph<F,N>, IPetriNet<F,N,P,T>

Direct Known Subclasses:

AbstractNetSystem, AbstractOccurrenceNet, PetriNet

public abstract class AbstractPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>
extends AbstractDirectedGraph<F,N>
implements IPetriNet<F,N,P,T>

An implementation of IPetriNet interface. TODO create and extend a bipartite graph.

Author:

Artem Polyvyanyy, Matthias Weidlich, Andreas Meyer

Field Summary

Fields inherited from class org.jbpt.hypergraph.abs.AbstractGraphNotifier

edges, vertices

Constructor Summary

Constructors

Constructor and Description
AbstractPetriNet() Empty constructor.

Method Summary

Methods

Modifier and Type	Method and Description
F	addFlow(P place, T transition) Add flow to this net.
F	addFlow(T transition, P place) Add flow to this net.
N	addNode(N node) Add node to this net.
Collection<N>	addNodes(Collection<N> nodes) Add nodes to this net.
P	addPlace(P place) Add place to this net.
Collection<P>	addPlaces(Collection<P> places) Add places to this net.
T	addTransition(T transition) Add transition to this net.
Collection<T>	addTransitions(Collection<T> transitions) Add transitions to this net.
void	clear() Clear this net.
IPetriNet<F,N,P,T>	clone() Clone this Petri net.
IPetriNet<F,N,P,T>	clone(Map<N,N> map) Clone this Petri net.
P	createPlace() Factory method to provide a place of the Petri net implementation.
T	createTransition() Factory method to provide a transition of the Petri net implementation.
Set<F>	getFlow() Get flow relation of this net.
Set<N>	getMax() Get maximal nodes of this net (alias of getSinkNodes).
Set<N>	getMin() Get minimal nodes of this net (alias of getSourceNodes).
Set<N>	getNodes() Get nodes of this net.
Set<T>	getObservableTransitions() Get observable transitions of this net.
Set<P>	getPlaces() Get places of this net.
Set<N>	getPostset(Collection<N> nodes) Get postset of given nodes.
Set<N>	getPostset(N node) Get postset of a given node.
Set<T>	getPostset(P place) Get postset of a given place
Set<P>	getPostset(T transition) Get postset of a given transition.
Set<P>	getPostsetPlaces(Collection<T> transitions) Get postset of given transitions.
Set<T>	getPostsetTransitions(Collection<P> places) Get postset of given places.
Set<N>	getPreset(Collection<N> nodes) Get preset of the given nodes.
Set<N>	getPreset(N node) Get preset of a given node.
Set<T>	getPreset(P place) Get preset of a given place.
Set<P>	getPreset(T transition) Get preset of a given transition.
Set<P>	getPresetPlaces(Collection<T> transitions) Get preset of given transitions.
Set<T>	getPresetTransitions(Collection<P> places) Get preset of given places.
Set<T>	getSilentTransitions() Get silent transitions of this net.
Set<N>	getSinkNodes() Get sink nodes of this net.
Set<P>	getSinkPlaces() Get sink places of this net.
Set<T>	getSinkTransitions() Get sink transitions of this net.
Set<N>	getSourceNodes() Get source nodes of this net.
Set<P>	getSourcePlaces() Get source places of this net.
Set<T>	getSourceTransitions() Get source transitions of this net.
Set<T>	getTransitions() Get transitions of this net.
Collection<F>	removeFlow(Collection<F> flow) Remove flow from this net.
F	removeFlow(F flow) Remove flow from this net.
N	removeNode(N node) Remove node from this net.
Collection<N>	removeNodes(Collection<N> nodes) Remove nodes from this net.
P	removePlace(P place) Remove place from this net.
Collection<P>	removePlaces(Collection<P> places) Remove places from this net.
T	removeTransition(T transition) Remove transition from this net.
Collection<T>	removeTransitions(Collection<T> transitions) Remove transitions from this net.
String	toDOT()

Methods inherited from class org.jbpt.graph.abs.AbstractDirectedGraph

addEdge, isMultiGraph

Methods inherited from class org.jbpt.graph.abs.AbstractMultiDirectedGraph

addEdge, areAdjacent, getDirectedEdge, getEdge, getEdges, getEdgesWithSources, getEdgesWithSourcesAndTargets, getEdgesWithTargets, removeVertex, removeVertices

Methods inherited from class org.jbpt.hypergraph.abs.AbstractMultiDirectedHyperGraph

addEdge, addEdge, checkEdge, getDirectPredecessors, getDirectPredecessors, getDirectSuccessors, getDirectSuccessors, getEdgesWithSource, getEdgesWithSourceAndTarget, getEdgesWithTarget, getFirstDirectPredecessor, getFirstDirectSuccessor, getFirstIncomingEdge, getFirstOutgoingEdge, getIncomingEdges, getOutgoingEdges

Methods inherited from class org.jbpt.hypergraph.abs.AbstractMultiHyperGraph

addVertex, addVertices, areAdjacent, checkEdge, contains, contains, contains, countEdges, countVertices, getAdjacent, getConnectedVertices, getDisconnectedVertices, getEdges, getEdges, getEdges, getEntities, getFreshVertex, getVertices, removeEdge, removeEdges, toString

Methods inherited from class org.jbpt.hypergraph.abs.AbstractGraphNotifier

addIndex, addIndex, clearMembers, removeIndex, removeIndex

Methods inherited from class org.jbpt.hypergraph.abs.GObject

compareTo, equals, getDescription, getId, getLabel, getName, getTag, hashCode, setDescription, setId, setName, setTag

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jbpt.petri.IPetriNet

addFlow

Methods inherited from interface org.jbpt.graph.abs.IDirectedGraph

getDirectedEdge

Methods inherited from interface org.jbpt.hypergraph.abs.IDirectedHyperGraph

addEdge, addEdge, getDirectPredecessors, getDirectPredecessors, getDirectSuccessors, getDirectSuccessors, getEdgesWithSource, getEdgesWithSourceAndTarget, getEdgesWithSources, getEdgesWithSourcesAndTargets, getEdgesWithTarget, getEdgesWithTargets, getFirstDirectPredecessor, getFirstDirectSuccessor, getFirstIncomingEdge, getFirstOutgoingEdge, getIncomingEdges, getOutgoingEdges

Methods inherited from interface org.jbpt.graph.abs.IGraph

areAdjacent, getEdge, getEdges

Methods inherited from interface org.jbpt.hypergraph.abs.IHyperGraph

addEdge, addEdge, addVertex, addVertices, areAdjacent, contains, contains, countEdges, countVertices, getAdjacent, getConnectedVertices, getDisconnectedVertices, getEdges, getEdges, getEdges, getFreshVertex, getVertices, isMultiGraph, removeEdge, removeEdges, removeVertex, removeVertices

Methods inherited from interface org.jbpt.hypergraph.abs.IGObject

getDescription, getId, getName, getTag, setDescription, setId, setName, setTag

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.jbpt.hypergraph.abs.IEntity

getLabel

Methods inherited from interface org.jbpt.hypergraph.abs.IEntityModel

getEntities

Constructor Detail

AbstractPetriNet

public AbstractPetriNet()

Empty constructor.

Method Detail

addFlow

public F addFlow(P place,
        T transition)

Description copied from interface: IPetriNet

Add flow to this net.

Specified by:

addFlow in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

place - Source place.

transition - Target transition.

Returns:

Flow added to this net; null if no flow was added.

addFlow

public F addFlow(T transition,
        P place)

Description copied from interface: IPetriNet

Add flow to this net.

Specified by:

addFlow in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

transition - Source transition.

place - Target place.

Returns:

Flow added to this net; null if no flow was added.

addNode

public N addNode(N node)

Description copied from interface: IPetriNet

Add node to this net.

Specified by:

addNode in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

node - Node to add.

Returns:

Node added to this net; null if no node was added.

addNodes

public Collection<N> addNodes(Collection<N> nodes)

Description copied from interface: IPetriNet

Add nodes to this net.

Specified by:

addNodes in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

nodes - Nodes to add.

Returns:

Nodes added to this net.

addPlace

public P addPlace(P place)

Description copied from interface: IPetriNet

Add place to this net.

Specified by:

addPlace in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

place - Place to add.

Returns:

Place added to this net; null if no place was added.

addPlaces

public Collection<P> addPlaces(Collection<P> places)

Description copied from interface: IPetriNet

Add places to this net.

Specified by:

addPlaces in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

places - Places to add.

Returns:

Places added to this net.

addTransition

public T addTransition(T transition)

Description copied from interface: IPetriNet

Add transition to this net.

Specified by:

addTransition in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

transition - Transition to add.

Returns:

Transition added to this net; null if no transition was added.

addTransitions

public Collection<T> addTransitions(Collection<T> transitions)

Description copied from interface: IPetriNet

Add transitions to this net.

Specified by:

addTransitions in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

transitions - Transitions to add.

Returns:

Transitions added to this net.

removeNode

public N removeNode(N node)

Description copied from interface: IPetriNet

Remove node from this net.

Specified by:

removeNode in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

node - Node to remove.

Returns:

Node removed from this net; null if node was not removed.

removeNodes

public Collection<N> removeNodes(Collection<N> nodes)

Description copied from interface: IPetriNet

Remove nodes from this net.

Specified by:

removeNodes in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

nodes - Nodes to remove.

Returns:

Nodes removed from this net.

removePlace

public P removePlace(P place)

Description copied from interface: IPetriNet

Remove place from this net.

Specified by:

removePlace in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

place - Place to remove.

Returns:

Place removed from this net; null if place was not removed.

removePlaces

public Collection<P> removePlaces(Collection<P> places)

Description copied from interface: IPetriNet

Remove places from this net.

Specified by:

removePlaces in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

places - Places to remove.

Returns:

Places removed from this net.

removeTransition

public T removeTransition(T transition)

Description copied from interface: IPetriNet

Remove transition from this net.

Specified by:

removeTransition in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

transition - Transition to remove.

Returns:

Transition removed from this net; null if transition was not removed.

removeTransitions

public Collection<T> removeTransitions(Collection<T> transitions)

Description copied from interface: IPetriNet

Remove transitions from this net.

Specified by:

removeTransitions in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

transitions - Transitions to remove.

Returns:

Transitions removed from this net.

removeFlow

public F removeFlow(F flow)

Description copied from interface: IPetriNet

Remove flow from this net.

Specified by:

removeFlow in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

flow - Flow to remove.

Returns:

Flow removed from this net; null if no flow was removed.

removeFlow

public Collection<F> removeFlow(Collection<F> flow)

Description copied from interface: IPetriNet

Remove flow from this net.

Specified by:

removeFlow in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

flow - Flow to remove.

Returns:

Flow removed from this net.

getNodes

public Set<N> getNodes()

Description copied from interface: IPetriNet

Get nodes of this net.

Specified by:

getNodes in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

Nodes of this net.

getPlaces

public Set<P> getPlaces()

Description copied from interface: IPetriNet

Get places of this net.

Specified by:

getPlaces in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

Places of this net.

getTransitions

public Set<T> getTransitions()

Description copied from interface: IPetriNet

Get transitions of this net.

Specified by:

getTransitions in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

Transitions of this net.

getFlow

public Set<F> getFlow()

Description copied from interface: IPetriNet

Get flow relation of this net.

Specified by:

getFlow in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

Flow relation of this net.

getSilentTransitions

public Set<T> getSilentTransitions()

Description copied from interface: IPetriNet

Get silent transitions of this net.

Specified by:

getSilentTransitions in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

Silent transitions of this net.

getObservableTransitions

public Set<T> getObservableTransitions()

Description copied from interface: IPetriNet

Get observable transitions of this net.

Specified by:

getObservableTransitions in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

Observable transitions of this net.

getPostset

public Set<P> getPostset(T transition)

Description copied from interface: IPetriNet

Get postset of a given transition.

Specified by:

getPostset in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

transition - Transition.

Returns:

Postset of the given transition.

getPostsetPlaces

public Set<P> getPostsetPlaces(Collection<T> transitions)

Description copied from interface: IPetriNet

Get postset of given transitions.

Specified by:

getPostsetPlaces in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

transitions - Transitions.

Returns:

Postset of the given transitions.

getPostset

public Set<T> getPostset(P place)

Description copied from interface: IPetriNet

Get postset of a given place

Specified by:

getPostset in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

place - Place.

Returns:

Postset of the given place.

getPostsetTransitions

public Set<T> getPostsetTransitions(Collection<P> places)

Description copied from interface: IPetriNet

Get postset of given places.

Specified by:

getPostsetTransitions in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

places - Places.

Returns:

Postset of the given places.

getPostset

public Set<N> getPostset(N node)

Description copied from interface: IPetriNet

Get postset of a given node.

Specified by:

getPostset in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

node - Node.

Returns:

Postset of the given node.

getPostset

public Set<N> getPostset(Collection<N> nodes)

Description copied from interface: IPetriNet

Get postset of given nodes.

Specified by:

getPostset in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

nodes - Nodes.

Returns:

Postset of given nodes.

getPreset

public Set<P> getPreset(T transition)

Description copied from interface: IPetriNet

Get preset of a given transition.

Specified by:

getPreset in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

transition - Transition.

Returns:

Preset of the given transition.

getPresetPlaces

public Set<P> getPresetPlaces(Collection<T> transitions)

Description copied from interface: IPetriNet

Get preset of given transitions.

Specified by:

getPresetPlaces in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

transitions - Transitions.

Returns:

Preset of given transitions.

getPreset

public Set<T> getPreset(P place)

Description copied from interface: IPetriNet

Get preset of a given place.

Specified by:

getPreset in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

place - Place.

Returns:

Preset of the given place.

getPresetTransitions

public Set<T> getPresetTransitions(Collection<P> places)

Description copied from interface: IPetriNet

Get preset of given places.

Specified by:

getPresetTransitions in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

places - Places.

Returns:

Preset of the given places.

getPreset

public Set<N> getPreset(N node)

Description copied from interface: IPetriNet

Get preset of a given node.

Specified by:

getPreset in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

node - Node.

Returns:

Preset of the given node.

getPreset

public Set<N> getPreset(Collection<N> nodes)

Description copied from interface: IPetriNet

Get preset of the given nodes.

Specified by:

getPreset in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

nodes - Nodes.

Returns:

Preset of the given nodes.

getSourcePlaces

public Set<P> getSourcePlaces()

Description copied from interface: IPetriNet

Get source places of this net. A place is a source place if it has empty preset.

Specified by:

getSourcePlaces in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

Source places of this net.

getSourceTransitions

public Set<T> getSourceTransitions()

Description copied from interface: IPetriNet

Get source transitions of this net. A transition is a source transition if it has empty preset.

Specified by:

getSourceTransitions in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

Source transitions of this net.

getSinkPlaces

public Set<P> getSinkPlaces()

Description copied from interface: IPetriNet

Get sink places of this net. A place is a sink place if it has empty postset.

Specified by:

getSinkPlaces in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

Sink places of this net.

getSinkTransitions

public Set<T> getSinkTransitions()

Description copied from interface: IPetriNet

Get sink transitions of this net. A transition is a sink transition if it has empty postset.

Specified by:

getSinkTransitions in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

Sink transitions of this net.

getMin

public Set<N> getMin()

Description copied from interface: IPetriNet

Get minimal nodes of this net (alias of getSourceNodes).

Specified by:

getMin in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

Minimal nodes of this net.

getMax

public Set<N> getMax()

Description copied from interface: IPetriNet

Get maximal nodes of this net (alias of getSinkNodes).

Specified by:

getMax in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

Maximal nodes of this net.

getSourceNodes

public Set<N> getSourceNodes()

Description copied from interface: IPetriNet

Get source nodes of this net. A node is a source node if it has empty preset.

Specified by:

getSourceNodes in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

Source nodes of this net.

getSinkNodes

public Set<N> getSinkNodes()

Description copied from interface: IPetriNet

Get sink nodes of this net. A node is a sink node if it has empty postset.

Specified by:

getSinkNodes in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

Sink nodes of this net.

clone

public IPetriNet<F,N,P,T> clone()

Description copied from interface: IPetriNet

Clone this Petri net.

Specified by:

clone in interface IEntity

Specified by:

clone in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Overrides:

clone in class GObject

clone

public IPetriNet<F,N,P,T> clone(Map<N,N> map)

Description copied from interface: IPetriNet

Clone this Petri net. The set map is a map from nodes of the original net to nodes of the cloned net.

Specified by:

clone in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

toDOT

public String toDOT()

Specified by:

toDOT in interface IGraph<F extends IFlow<N>,N extends INode>

Overrides:

toDOT in class AbstractMultiDirectedGraph<F extends IFlow<N>,N extends INode>

createTransition

public T createTransition()

Description copied from interface: IPetriNet

Factory method to provide a transition of the Petri net implementation.

Specified by:

createTransition in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

A fresh transition.

createPlace

public P createPlace()

Description copied from interface: IPetriNet

Factory method to provide a place of the Petri net implementation.

Specified by:

createPlace in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

A fresh place.

clear

public void clear()

Description copied from interface: IPetriNet

Clear this net.

Specified by:

clear in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>