org.opencompare.api.java

Class PCMMetadata

java.lang.Object

org.opencompare.api.java.PCMMetadata

public class PCMMetadata
extends Object

Created by gbecan on 6/10/15.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	creator
protected Map<AbstractFeature,Integer>	featurePositions
protected String	license
protected PCM	pcm
protected Boolean	productAsLines
protected Map<Product,Integer>	productPositions
protected String	source

Constructor Summary

Constructors

Constructor and Description
PCMMetadata(PCM pcm)

Method Summary

Modifier and Type	Method and Description
void	clearFeaturePosition(AbstractFeature feature)
void	clearProductPosition(Product product)
boolean	equals(Object obj)
String	getCreator()
int	getFeaturePosition(AbstractFeature feature) Returns the absolute position of the feature or create if not exists
List<List<AbstractFeature>>	getFlattenFeatureHierarchy() Return the flatten hierarchy of features The features are sorted with respect to the metadata Feature groups are referenced multiple times to respect the hierarchy with the subfeatures e.g.
int	getLastFeatureIndex() Return the last feature index used
int	getLastProductIndex() Return the last product index used
String	getLicense()
PCM	getPcm()
Boolean	getProductAsLines()
int	getProductPosition(Product product) Returns the absolute position of the product or create if not exists
List<Feature>	getSortedFeatures() Return the sorted features concordingly with metadata
List<Product>	getSortedProducts() Return the sorted products concordingly with metadata
String	getSource()
void	setCreator(String creator)
void	setFeaturePosition(AbstractFeature feature, int position) Define the absolute position of the feature in the PCM
void	setLicense(String license)
void	setProductAsLines(Boolean productAsLines)
void	setProductPosition(Product product, int position) Define the absolute position of the product in the PCM
void	setSource(String source)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

pcm

protected PCM pcm

productAsLines

protected Boolean productAsLines

productPositions

protected Map<Product,Integer> productPositions

featurePositions

protected Map<AbstractFeature,Integer> featurePositions

source

protected String source

license

protected String license

creator

protected String creator

Constructor Detail

PCMMetadata

public PCMMetadata(PCM pcm)

Method Detail

getLastProductIndex

public int getLastProductIndex()

Return the last product index used

Returns:

a integer as index

getLastFeatureIndex

public int getLastFeatureIndex()

Return the last feature index used

Returns:

a integer as index

getProductPosition

public int getProductPosition(Product product)

Returns the absolute position of the product or create if not exists

Parameters:

product - product

Returns:

the absolution position of 'product' or -1 if it is not specified

setProductPosition

public void setProductPosition(Product product,
                               int position)

Define the absolute position of the product in the PCM

Parameters:

product - product

position - position

getFeaturePosition

public int getFeaturePosition(AbstractFeature feature)

Returns the absolute position of the feature or create if not exists

Parameters:

feature -

Returns:

the absolution position of 'feature' or -1 if it is not specified

setFeaturePosition

public void setFeaturePosition(AbstractFeature feature,
                               int position)

Define the absolute position of the feature in the PCM

Parameters:

feature - feature

position - position

getSortedProducts

public List<Product> getSortedProducts()

Return the sorted products concordingly with metadata

Returns:

an ordered list of products

getSortedFeatures

public List<Feature> getSortedFeatures()

Return the sorted features concordingly with metadata

Returns:

an ordered list of features

getFlattenFeatureHierarchy

public List<List<AbstractFeature>> getFlattenFeatureHierarchy()

Return the flatten hierarchy of features The features are sorted with respect to the metadata Feature groups are referenced multiple times to respect the hierarchy with the subfeatures e.g. FG(A,B) gives FG, FG; A, B

Returns:

flatten hierarchy

getSource

public String getSource()

setSource

public void setSource(String source)

getLicense

public String getLicense()

setLicense

public void setLicense(String license)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getPcm

public PCM getPcm()

getProductAsLines

public Boolean getProductAsLines()

setProductAsLines

public void setProductAsLines(Boolean productAsLines)

getCreator

public String getCreator()

setCreator

public void setCreator(String creator)

clearProductPosition

public void clearProductPosition(Product product)

clearFeaturePosition

public void clearFeaturePosition(AbstractFeature feature)