org.processmining.plugins.properties.processmodel

Interface Property<K>

Type Parameters:

K -

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ConfigurableProperty<K>

All Known Implementing Classes:

ArrivalProcess, AutomaticDistribution, ConfigurableArrivalProcess, ConfigurableAutomaticDistribution, ConfigurableDataValueMatrix, ConfigurableDataValues, ConfigurableHighLevelProperty, ConfigurableInitialDataValue, ConfigurableMcDonaldsIndex, ConfigurableMonotonicityRole, ConfigurableOutgoingProbability, ConfigurablePropertyDistribution, ConfigurablePropertyDouble, ConfigurablePropertyList, ConfigurablePropertyListDistribution, ConfigurablePropertyListDistributionImExporter, ConfigurablePropertyListDouble, ConfigurablePropertyListList, ConfigurablePropertyListString, ConfigurablePropertySingleElement, ConfigurablePropertyString, ConfigurableTaskDistribution, Costs, DataValueMatrix, DataValues, Distribution, EventDistribution, EventTime, Fitness, HighLevelProperty, InitialDataValue, LoopCutOffProbability, McDonaldsIndex, NrOfCases, NrOfControlTasks, NrOfResources, ORSemantic, OutgoingProbability, PointProbability, PointProbabilityOrder, ProcessingTime, ProcessingTimeOrder, PropertyBoolean, PropertyDistribution, PropertyDouble, PropertyInteger, PropertyList, PropertyListDouble, PropertyListString, PropertyListTimeValue, PropertyLong, PropertyMapDoubleDouble, PropertyMapIntegerDouble, PropertyOROptions, PropertyString, QueueTime, QueueTimeOrder, ResourceUtilisation, Role, RunningTime, SimulationProperty, TaskDistribution, ThroughputTime, ThroughputTimeOrder, Utilisation, WaitTime, WaitTimeOrder, WorkSchedule, YerkesDodsonInterval

public interface Property<K>
extends java.io.Serializable

Author:

DSchunse

Method Summary

Modifier and Type	Method and Description
K	clone(java.lang.Object element)
int	compare(java.lang.Object o1, java.lang.Object o2)
K	getDefaultValue() We want to have a default value for a property s.t., we can reason on it
java.util.Collection<java.lang.Class<? extends Property<?>>>	getDependencies()
GUIProperty<K>	getGUIProperty()
javax.swing.ImageIcon	getIcon()
java.lang.Long	getID()
java.util.Set<Constructs>	getMeaningfulTypeConstructs()
java.lang.String	getName()
double	getValueDouble(java.lang.Object value)
boolean	hasOrdering()
boolean	higherBetter()
java.lang.String	marshall(java.lang.Object value)
java.util.Set<Constructs>	monotonicity()
java.lang.Object	unmarshall(java.lang.String xml)

Method Detail

getID

java.lang.Long getID()

Returns:

the unique ID for this property for import and export functionality

getName

java.lang.String getName()

Returns:

the print friendly name of this property

clone

K clone(java.lang.Object element)

Returns:

the cloned version of this property

compare

int compare(java.lang.Object o1,
            java.lang.Object o2)

Parameters:

o1 - a value for a property

o2 - another value for a property

Returns:

> 0 if and only if o1 is better than o2

getDependencies

java.util.Collection<java.lang.Class<? extends Property<?>>> getDependencies()

Returns:

The dependencies of this property, some properties can only be set when certain other properties have been set

monotonicity

java.util.Set<Constructs> monotonicity()

Returns:

the set of constructs under which this property is monotone

getMeaningfulTypeConstructs

java.util.Set<Constructs> getMeaningfulTypeConstructs()

Returns:

returns the type of objects for which it makes sense to have this property

getDefaultValue

K getDefaultValue()

We want to have a default value for a property s.t., we can reason on it

Returns:

The default value of a property

getValueDouble

double getValueDouble(java.lang.Object value)

Parameters:

value - The value one wants to have a single double of

Returns:

getIcon

javax.swing.ImageIcon getIcon()

Returns:

the icon to be used in the visualisation (note this can be null)

getGUIProperty

GUIProperty<K> getGUIProperty()
                       throws java.lang.InstantiationException,
                              java.lang.IllegalAccessException

Returns:

the GUI to set this property

Throws:

java.lang.IllegalAccessException

java.lang.InstantiationException

hasOrdering

boolean hasOrdering()

Returns:

denotes if the ordering matters (e.g., distribution does not have an ordering)

higherBetter

boolean higherBetter()

Returns:

denotes if a higher value is better or not

marshall

java.lang.String marshall(java.lang.Object value)

Parameters:

value - the value of the object to be written

Returns:

the xml string of the object

unmarshall

java.lang.Object unmarshall(java.lang.String xml)

Parameters:

xml - the xml fragment to be parsed

Returns:

the initialised data-structure