nl.uu.cs.ape.sat.automaton.State Maven / Gradle / Ivy
package nl.uu.cs.ape.sat.automaton;
import nl.uu.cs.ape.sat.models.enums.WorkflowElement;
import nl.uu.cs.ape.sat.models.logic.constructs.PredicateLabel;
/***
* The {@code State} class is used to represent the states in module and type automatons. Automaton corresponds to the structure of the possible solutions of the synthesis, i.e. it represents the structure that the provided solutions will follow.
*
* Labeling of the automaton is provided in
* /APE/res/WorkflowAutomaton_Implementation.png.
*
* @author Vedran Kasalica
*/
public class State implements PredicateLabel {
private final String stateName;
private final int stateNumber;
private final int absoluteStateNumber;
private final WorkflowElement workflowStateType;
/**
* Creates a state that corresponds to a state of the overall solution workflow.
*
* @param workflowStateType Parameter determining the state type.
* @param blockNumber Corresponds to the block number within the type automaton (not applicable for the module automaton).
* @param stateNumber Corresponds to the state number within block.
* @param inputBranching Max number of inputs per module.
* @param outputBranching Max number of outputs per module.
*/
public State(WorkflowElement workflowStateType, Integer blockNumber, int stateNumber, int inputBranching, int outputBranching) {
this.stateName = WorkflowElement.getStringShortcut(workflowStateType, blockNumber, stateNumber);
this.stateNumber = stateNumber;
this.absoluteStateNumber = calculateAbsStateNumber(blockNumber, stateNumber, inputBranching, outputBranching, workflowStateType);
this.workflowStateType = workflowStateType;
}
/* (non-Javadoc)
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + absoluteStateNumber;
result = prime * result + ((stateName == null) ? 0 : stateName.hashCode());
return result;
}
/* (non-Javadoc)
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
State other = (State) obj;
if (absoluteStateNumber != other.absoluteStateNumber)
return false;
if (stateName == null) {
if (other.stateName != null)
return false;
} else if (!stateName.equals(other.stateName))
return false;
return true;
}
/**
* Compares the two States based on their order in the solution.
*
* @return Negative integer, zero, or a positive integer as this object is before than, equal to, or after than the specified State.
*/
@Override
public int compareTo(PredicateLabel other) {
if (!(other instanceof State)) {
return this.getPredicateID().compareTo(other.getPredicateID());
}
State otherState = (State) other;
int diff = 0;
if ((diff = Integer.compare(this.absoluteStateNumber, otherState.absoluteStateNumber)) != 0) {
return diff;
} else {
return this.getPredicateID().compareTo(otherState.getPredicateID());
}
}
/**
* Returns the text representing the state (e.g. M04 or T02.31).
*
* @return String representation of the state.
*/
public String getPredicateID() {
return stateName;
}
/**
* Returns the text representing the state (e.g. M04 or T02.31).
*
* @return String representation of the state.
*/
public String getPredicateLabel() {
return stateName;
}
/**
* Returns the text representing the state (e.g. M04 or T02.31).
*
* @return String representation of the state.
*/
public String getPredicateLongLabel() {
return stateName;
}
/**
* Returns the order number of the state in the respective array of states.
*
* @return Order number of the state (within the block).
*/
public int getStateNumber() {
return stateNumber;
}
/**
* Returns the absolute order number of the state within the whole workflow. Unlike {@link #getStateNumber}, this function returns number that can be used to compare ordering of any 2 states in the system,
* disregarding the block or their type (data type, tool, etc.). null state has AbsoluteStateNumber -1.
*
* @return Non-negative number that corresponds to the absolute order number of the state or -1 for null state.
*/
public int getAbsoluteStateNumber() {
return absoluteStateNumber;
}
/**
* Get the type of the state (e.g. tool, memory type, etc.).
*
* @return The {@link WorkflowElement} that describes the state.
*/
public WorkflowElement getWorkflowStateType() {
return workflowStateType;
}
/**
* Function used to calculate the absolute order number of a state based on the information regarding its block number, order number within the block and type of the state.
*
* {@link WorkflowElement#MEMORY_TYPE} corresponds to the Memory Type State,
* {@link WorkflowElement#USED_TYPE} corresponds to the Used Type State,
* {@link WorkflowElement#MODULE} corresponds to the Module/Tool State.
*
* @param blockNumber Corresponds to the block number within the type automaton (not applicable for the module automaton).
* @param stateNumber Corresponds to the state number within block.
* @param inputBranching Max number of inputs per module.
* @param outputBranching Max number of outputs per module.
* @param typeOfTheState Parameter determining the state type.
* @return The calculated absolute order number of the state.
*/
private static int calculateAbsStateNumber(Integer blockNumber, int stateNumber, int inputBranching, int outputBranching, WorkflowElement typeOfTheState) {
int absOrderNumber = -1;
if (typeOfTheState == WorkflowElement.MEMORY_TYPE) { /* Case: Memory Type State */
absOrderNumber = (blockNumber * (inputBranching + outputBranching)) + blockNumber + stateNumber;
} else if (typeOfTheState == WorkflowElement.USED_TYPE) { /* Case: Used Type State */
absOrderNumber = (blockNumber * (inputBranching + outputBranching)) + blockNumber + outputBranching + stateNumber;
} else if (typeOfTheState == WorkflowElement.MODULE) { /* Case: Module/Tool State */
absOrderNumber = (stateNumber * (inputBranching + outputBranching) * 2) + stateNumber - 1;
}
return absOrderNumber;
}
}
