org.opencompare.api.java

Interface PCM

All Superinterfaces:

PCMElement

public interface PCM
extends PCMElement

Method Summary

Modifier and Type	Method and Description
void	addFeature(AbstractFeature feature)
void	addProduct(Product product)
DiffResult	diff(PCM pcm, PCMElementComparator pcmElementComparator) Compute the difference with another PCM
List<Feature>	getConcreteFeatures() List all the features of the PCM (no feature group is returned)
List<AbstractFeature>	getFeatures()
int	getFeaturesDepth()
String	getName()
Feature	getOrCreateFeature(String name, PCMFactory factory) Retrieve an existing feature If the feature does not exist, we create and add it to the PCM
Product	getOrCreateProduct(String name, PCMFactory factory) Retrieve an existing product If the product does not exist, we create and add it to the PCM
List<Product>	getProducts()
Feature	getProductsKey()
void	invert(PCMFactory factory) Invert the matrix (products become features and vice versa)
boolean	isValid() Check if the PCM is well formed
void	merge(PCM pcm, PCMFactory factory) Add information from another PCM
void	normalize(PCMFactory factory) Fill missing cells with not available cells
void	removeFeature(AbstractFeature feature)
void	removeProduct(Product product)
void	setName(String name)
void	setProductsKey(Feature feature)

Methods inherited from interface org.opencompare.api.java.PCMElement

accept, clone

Method Detail

getName

String getName()

setName

void setName(String name)

getProducts

List<Product> getProducts()

addProduct

void addProduct(Product product)

removeProduct

void removeProduct(Product product)

getProductsKey

Feature getProductsKey()

setProductsKey

void setProductsKey(Feature feature)

getFeatures

List<AbstractFeature> getFeatures()

addFeature

void addFeature(AbstractFeature feature)

removeFeature

void removeFeature(AbstractFeature feature)

getConcreteFeatures

List<Feature> getConcreteFeatures()

List all the features of the PCM (no feature group is returned)

Returns:

features of the PCM

getOrCreateFeature

Feature getOrCreateFeature(String name,
                           PCMFactory factory)

Retrieve an existing feature If the feature does not exist, we create and add it to the PCM

Parameters:

name - name of the feature to search

factory - : PCM factory

Returns:

searched feature

getOrCreateProduct

Product getOrCreateProduct(String name,
                           PCMFactory factory)

Retrieve an existing product If the product does not exist, we create and add it to the PCM

Parameters:

name - name of the product to search

factory - PCM factory

Returns:

searched product

merge

void merge(PCM pcm,
           PCMFactory factory)
    throws MergeConflictException

Add information from another PCM

Parameters:

pcm - PCM to merge

factory - PCM factory

Throws:

MergeConflictException

isValid

boolean isValid()

Check if the PCM is well formed

Returns:

the PCM is well formed

normalize

void normalize(PCMFactory factory)

Fill missing cells with not available cells

Parameters:

factory - PCM factory

diff

DiffResult diff(PCM pcm,
                PCMElementComparator pcmElementComparator)

Compute the difference with another PCM

Parameters:

pcm - PCM to compare with

pcmElementComparator - comparator to use to compute the difference between the elements of the PCM

Returns:

difference between the two PCMs

invert

void invert(PCMFactory factory)

Invert the matrix (products become features and vice versa)

Parameters:

factory - PCM factory

getFeaturesDepth

int getFeaturesDepth()