pledge.core

Class ModelPLEDGE

java.lang.Object

java.util.Observable

pledge.core.ModelPLEDGE

public class ModelPLEDGE
extends java.util.Observable

This class represents the model of the application. It contains the methods to perform the business logic of the application: load a feature model, perform the products' prioritization, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelPLEDGE.FeatureModelFormat

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NOT
static java.lang.String	OR

Constructor Summary

Constructors

Constructor and Description
ModelPLEDGE() Creates the model of the application.

Method Summary

Methods

Modifier and Type	Method and Description
void	generateProducts() Generate products.
java.util.List<java.lang.String>	getCoreFeatures() Returns the core features of the feature model.
java.lang.String	getCurrentAction() Returns the current action performed by the tool.
java.util.List<java.lang.String>	getDeadFeatures() Returns the dead features of the feature model.
java.util.List<org.sat4j.specs.IConstr>	getFeatureModelConstraints() Returns the constraints of the feature model.
java.util.List<java.lang.String>	getFeatureModelConstraintsString() Returns the constraints of the feature model.
ModelPLEDGE.FeatureModelFormat	getFeatureModelFormat() Returns the format of the currently loaded feature model.
java.lang.String	getFeatureModelName() Returns the name of the currently loaded feature model.
java.util.List<java.lang.Integer>	getFeaturesIntList() Returns an indices list of the features.
java.util.List<java.lang.String>	getFeaturesList() returns the features' list of the feature model.
java.lang.String	getFeatureType(java.lang.String feature) Return the type of a given feature (i.e. core, dead or free)
GenerationTechnique	getGenerationTechnique() Returns the specified generation technique.
java.util.List<GenerationTechnique>	getGenerationTechniques() Returns the generation techniques available.
long	getGenerationTimeMSAllowed() Returns the amount of time allowed for generating products.
java.lang.String	getGlobalAction() Returns the current global action performed by the tool.
java.util.Map<java.lang.String,java.lang.Integer>	getNamesToFeaturesInt() Returns a mapping between each feature and its corresponding index.
int	getNbProductsToGenerate() Returns the number of products to generate.
PrioritizationTechnique	getPrioritizationTechnique() Returns the specified prioritization technique.
java.util.List<PrioritizationTechnique>	getPrioritizationTechniques() Returns the prioritization techniques available.
java.util.List<Product>	getProducts() Returns the list of products currently loaded into the application.
int	getProgress() Return the progress of the current action performed by the tool (percentage)
org.sat4j.minisat.core.Solver	getSolver() Returns the SAT solver.
org.sat4j.specs.ISolver	getSolverIterator() Returns the solver iterator that is used to generate valid products.
java.util.List<Product>	getUnpredictableProducts(int count) returns n products obtained at random from the solver.
boolean	isIndeterminate() Specifies whether the duration of current action performed by the tool is indeterminate or not.
boolean	isRunning() Checks if the application is running.
void	loadFeatureModel(java.lang.String filePath, ModelPLEDGE.FeatureModelFormat format) Load a feature model.
void	loadProducts(java.lang.String inFile) Load products from a file.
void	prioritizeProducts() Prioritize products.
void	quit() Quit the application.
void	saveProducts(java.lang.String outFile) Save products to a file.
void	setCurrentAction(java.lang.String currentAction) Specifies the current action performed by the tool.
void	SetGenerationTechniqueByName(java.lang.String name) Specifies the generation technique used by the tool.
void	setGenerationTimeMSAllowed(long generationTimeMSAllowed) Specifies the amount of time allowed for generating products.
void	setGlobalAction(java.lang.String globalAction) Specifies the current global action performed by the tool.
void	setIndeterminate(boolean indeterminate) Specifies wether the duration of current action performed by the tool is indeterminate or not.
void	setNbProductsToGenerate(int nbProductsToGenerate) Specifies the number of products to generate.
void	SetPrioritizationTechniqueByName(java.lang.String name) Specifies the prioritization technique used by the tool.
void	setProgress(int progress) Specifies the progress of the current action performed by the tool (percentage)
void	setRunning(boolean running) Specifies whether the application is running or not.

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Field Detail

OR

public static final java.lang.String OR

See Also:

Constant Field Values

NOT

public static final java.lang.String NOT

See Also:

Constant Field Values

Constructor Detail

ModelPLEDGE

public ModelPLEDGE()

Creates the model of the application.

Method Detail

getFeatureModelFormat

public ModelPLEDGE.FeatureModelFormat getFeatureModelFormat()

Returns the format of the currently loaded feature model.

Returns:

the format of the current feature model.

getFeatureModelName

public java.lang.String getFeatureModelName()

Returns the name of the currently loaded feature model.

Returns:

the name of the currently loaded feature model.

getFeaturesIntList

public java.util.List<java.lang.Integer> getFeaturesIntList()

Returns an indices list of the features.

Returns:

a list containing the indices of the feature model's features.

getFeaturesList

public java.util.List<java.lang.String> getFeaturesList()

returns the features' list of the feature model.

Returns:

a list of features of the feature model.

getNamesToFeaturesInt

public java.util.Map<java.lang.String,java.lang.Integer> getNamesToFeaturesInt()

Returns a mapping between each feature and its corresponding index.

Returns:

a map containing the index of each feature.

getFeatureModelConstraints

public java.util.List<org.sat4j.specs.IConstr> getFeatureModelConstraints()

Returns the constraints of the feature model.

Returns:

a list containing the constraints of the feature model.

getFeatureModelConstraintsString

public java.util.List<java.lang.String> getFeatureModelConstraintsString()

Returns the constraints of the feature model.

Returns:

a list containing a String represent of the constraints of the feature model.

getSolver

public org.sat4j.minisat.core.Solver getSolver()

Returns the SAT solver.

Returns:

the SAT solver asosciated to this model.

isRunning

public boolean isRunning()

Checks if the application is running.

Returns:

true if the program is running.

getProducts

public java.util.List<Product> getProducts()

Returns the list of products currently loaded into the application.

Returns:

the generated or priotized products.

getGenerationTimeMSAllowed

public long getGenerationTimeMSAllowed()

Returns the amount of time allowed for generating products.

Returns:

the amount of time in seconds allowed for generating products.

setGenerationTimeMSAllowed

public void setGenerationTimeMSAllowed(long generationTimeMSAllowed)

Specifies the amount of time allowed for generating products.

Parameters:

generationTimeMSAllowed - the amount of time in seconds allowed for generating products.

getNbProductsToGenerate

public int getNbProductsToGenerate()

Returns the number of products to generate.

Returns:

an integer representing the number of products to generate.

setNbProductsToGenerate

public void setNbProductsToGenerate(int nbProductsToGenerate)

Specifies the number of products to generate.

Parameters:

nbProductsToGenerate - the number of products to generate.

setRunning

public void setRunning(boolean running)

Specifies whether the application is running or not.

Parameters:

running - a boolean indicating whether the application is running or not.

isIndeterminate

public boolean isIndeterminate()

Specifies whether the duration of current action performed by the tool is indeterminate or not.

Returns:

true if the duration of current action performed by the tool is indeterminate.

getProgress

public int getProgress()

Return the progress of the current action performed by the tool (percentage)

Returns:

an integer representing the percentage of the current action performed.

setProgress

public void setProgress(int progress)

Specifies the progress of the current action performed by the tool (percentage)

Parameters:

progress - an integer representing the percentage of the current action performed.

setIndeterminate

public void setIndeterminate(boolean indeterminate)

Specifies wether the duration of current action performed by the tool is indeterminate or not.

Parameters:

indeterminate - a boolean specifying wether the duration of current action performed by the tool is indeterminate or not.

getSolverIterator

public org.sat4j.specs.ISolver getSolverIterator()

Returns the solver iterator that is used to generate valid products.

Returns:

the solver iterator that is used to generate valid products.

getCurrentAction

public java.lang.String getCurrentAction()

Returns the current action performed by the tool.

Returns:

a String representing the current action performed by the tool.

setCurrentAction

public void setCurrentAction(java.lang.String currentAction)

Specifies the current action performed by the tool.

Parameters:

currentAction - a String representing the action which is currently performed by the tool.

getGlobalAction

public java.lang.String getGlobalAction()

Returns the current global action performed by the tool.

Returns:

a String representing the current global action performed by the tool.

setGlobalAction

public void setGlobalAction(java.lang.String globalAction)

Specifies the current global action performed by the tool.

Parameters:

globalAction - a String representing the global action which is currently performed by the tool.

getCoreFeatures

public java.util.List<java.lang.String> getCoreFeatures()

Returns the core features of the feature model.

Returns:

the list of mandatory features of the feature model.

getDeadFeatures

public java.util.List<java.lang.String> getDeadFeatures()

Returns the dead features of the feature model.

Returns:

the list of dead features of the feature model.

getGenerationTechnique

public GenerationTechnique getGenerationTechnique()

Returns the specified generation technique.

Returns:

the technique used by the tool to generate products.

SetGenerationTechniqueByName

public void SetGenerationTechniqueByName(java.lang.String name)

Specifies the generation technique used by the tool.

Parameters:

name - the name of the generation technique that has to be used to generate products.

getGenerationTechniques

public java.util.List<GenerationTechnique> getGenerationTechniques()

Returns the generation techniques available.

Returns:

a list containing the available generation techniques.

getPrioritizationTechnique

public PrioritizationTechnique getPrioritizationTechnique()

Returns the specified prioritization technique.

Returns:

the technique used by the tool to prioritize products.

SetPrioritizationTechniqueByName

public void SetPrioritizationTechniqueByName(java.lang.String name)

Specifies the prioritization technique used by the tool.

Parameters:

name - the name of the prioritization technique that has to be used to prioritize products.

getPrioritizationTechniques

public java.util.List<PrioritizationTechnique> getPrioritizationTechniques()

Returns the prioritization techniques available.

Returns:

a list containing the available prioritization techniques.

loadFeatureModel

public void loadFeatureModel(java.lang.String filePath,
                    ModelPLEDGE.FeatureModelFormat format)
                      throws java.lang.Exception

Load a feature model.

Parameters:

filePath - the path to the feature model file.

format - the format of the feature model.

Throws:

java.lang.Exception - if the file format is incorrect.

generateProducts

public void generateProducts()
                      throws java.lang.Exception

Generate products.

Throws:

java.lang.Exception - if an error occurs during the generation.

prioritizeProducts

public void prioritizeProducts()
                        throws java.lang.Exception

Prioritize products.

Throws:

java.lang.Exception - if an error occur while prioritizing the products.

getFeatureType

public java.lang.String getFeatureType(java.lang.String feature)

Return the type of a given feature (i.e. core, dead or free)

Parameters:

feature - the name of the feature.

Returns:

a String representing the type of this feature (core, dead or free).

getUnpredictableProducts

public java.util.List<Product> getUnpredictableProducts(int count)

returns n products obtained at random from the solver.

Parameters:

count - the number of products to get.

Returns:

the list of products obtained at random for the solver.

saveProducts

public void saveProducts(java.lang.String outFile)
                  throws java.lang.Exception

Save products to a file.

Parameters:

outFile - the file to write the products in.

Throws:

java.lang.Exception - if an error occurs while writing the products to the file.

loadProducts

public void loadProducts(java.lang.String inFile)
                  throws java.lang.Exception

Load products from a file.

Parameters:

inFile - the file to loead the products from.

Throws:

java.lang.Exception - if an error occurs while reading the products file.

quit

public void quit()

Quit the application.