cz.diribet.aqdef.model

Class AqdefObjectModel

java.lang.Object

cz.diribet.aqdef.model.AqdefObjectModel

public class AqdefObjectModel
extends Object

Object model of AQDEF content.

Provides methods to manipulate with the content (getXXX, putXXX, removeXXX, filterXXX) and to iterate through the content (forEachXXX).

Use AqdefParser to read AQDEF content and AqdefWriter to write this object model as AQDEF content.

Author:

Vlastimil Dolejs

See Also:

AqdefParser, AqdefWriter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AqdefObjectModel.AbstractEntry<I>
static interface	AqdefObjectModel.CharacteristicConsumer
static class	AqdefObjectModel.CharacteristicEntries
static class	AqdefObjectModel.CharacteristicEntry
static interface	AqdefObjectModel.CharacteristicOfSinglePartConsumer
static interface	AqdefObjectModel.CharacteristicOfSinglePartPredicate
static interface	AqdefObjectModel.CharacteristicPredicate
static class	AqdefObjectModel.Entries<E extends AqdefObjectModel.AbstractEntry<I>,I>
static interface	AqdefObjectModel.GroupConsumer
static class	AqdefObjectModel.GroupEntries
static class	AqdefObjectModel.GroupEntry
static interface	AqdefObjectModel.GroupOfSinglePartConsumer
static interface	AqdefObjectModel.PartConsumer
static class	AqdefObjectModel.PartEntries
static class	AqdefObjectModel.PartEntry
static interface	AqdefObjectModel.PartPredicate
static interface	AqdefObjectModel.ValueConsumer
static class	AqdefObjectModel.ValueEntries
static class	AqdefObjectModel.ValueEntry
static interface	AqdefObjectModel.ValueOfSingleCharacteristicConsumer
static interface	AqdefObjectModel.ValueOfSingleCharacteristicPredicate
static interface	AqdefObjectModel.ValueOfSinglePartConsumer
static interface	AqdefObjectModel.ValueOfSinglePartPredicate
static interface	AqdefObjectModel.ValuePredicate
static class	AqdefObjectModel.ValueSet Contains one "set" of values for all characteristics.

Constructor Summary

Constructors

Constructor and Description
AqdefObjectModel()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
void	filterCharacteristics(AqdefObjectModel.CharacteristicPredicate predicate) Removes all characteristics that do not match the given predicate.
void	filterCharacteristics(AqdefObjectModel.PartEntries part, AqdefObjectModel.CharacteristicOfSinglePartPredicate predicate) Removes all characteristics of the given part that do not match the given predicate.
void	filterParts(AqdefObjectModel.PartPredicate predicate) Removes all parts that do not match the given predicate.
void	filterValues(AqdefObjectModel.PartEntries part, AqdefObjectModel.CharacteristicEntries characteristic, AqdefObjectModel.ValueOfSinglePartPredicate predicate) Removes all values of the given characteristic that do not match the given predicate.
void	filterValues(AqdefObjectModel.PartEntries part, AqdefObjectModel.ValueOfSinglePartPredicate predicate) Removes all values of the given part that do not match the given predicate.
void	filterValues(AqdefObjectModel.ValuePredicate predicate) Removes all values that do not match the given predicate.
Set<CharacteristicIndex>	findCharacteristicIndexesForPart(PartIndex partIndex, AqdefObjectModel.CharacteristicOfSinglePartPredicate predicate)
PartIndex	findPartIndexForCharacteristic(int characteristicIndex) Finds part index to which the given characteristic index belongs.
void	forEachCharacteristic(AqdefObjectModel.CharacteristicConsumer consumer) Iterates through all characteristics of all parts
void	forEachCharacteristic(AqdefObjectModel.PartEntries part, AqdefObjectModel.CharacteristicOfSinglePartConsumer consumer) Iterates through all characteristics of the given part.
void	forEachGroup(AqdefObjectModel.GroupConsumer consumer) Iterates through all logical groups of all parts
void	forEachGroup(AqdefObjectModel.PartEntries part, AqdefObjectModel.GroupOfSinglePartConsumer consumer) Iterates through all logical groups of the given part.
void	forEachPart(AqdefObjectModel.PartConsumer consumer) Iterates through all parts
void	forEachValue(AqdefObjectModel.PartEntries part, AqdefObjectModel.CharacteristicEntries characteristic, AqdefObjectModel.ValueOfSingleCharacteristicConsumer consumer) Iterates through all values of the given characteristic.
void	forEachValue(AqdefObjectModel.PartEntries part, AqdefObjectModel.ValueOfSinglePartConsumer consumer) Iterates through all values of the given part.
void	forEachValue(AqdefObjectModel.ValueConsumer consumer) Iterates through all values.
Object	getAnyValueOf(KKey key) Finds value of the given K-key from any part / characteristic / value.
int	getCharacteristicCount() Returns total number of characteristics of all parts in this object model
AqdefObjectModel.CharacteristicEntries	getCharacteristicEntries(CharacteristicIndex characteristicIndex)
AqdefObjectModel.CharacteristicEntries	getCharacteristicEntries(int partIndex, int characteristicIndex)
List<CharacteristicIndex>	getCharacteristicIndexes(PartIndex partIndex) Returns indexes of all characteristics of a part with the given index.
AqdefHierarchy	getHierarchy()
AqdefObjectModel.PartEntries	getPartEntries(int index)
AqdefObjectModel.PartEntries	getPartEntries(PartIndex index)
List<PartIndex>	getPartIndexes() Returns indexes of all parts in this object model.
int	getValueCount() Returns total number of values of all parts and characteristics in this object model
List<AqdefObjectModel.ValueEntries>	getValueEntries(CharacteristicIndex characteristicIndex)
AqdefObjectModel.ValueEntries	getValueEntries(int partIndex, int characteristicIndex, int valueIndex)
AqdefObjectModel.ValueEntries	getValueEntries(ValueIndex valueIndex)
List<ValueIndex>	getValueIndexes() Returns indexes of all values in this object model.
List<ValueIndex>	getValueIndexes(CharacteristicIndex characteristicIndex) Returns indexes of all values of a characteristics with the given index.
List<AqdefObjectModel.ValueSet>	getValueSets(PartIndex partIndex)
int	hashCode()
void	normalize() Apply all /0 K-keys on all parts / characteristics / values and then remove them from object model.
void	putCharacteristicEntry(KKey key, CharacteristicIndex characteristicIndex, Object value)
void	putGroupEntry(KKey key, GroupIndex groupIndex, Object value)
void	putHierarchyEntry(KKey kKey, Integer nodeIndex, Object value)
void	putPartEntry(KKey key, PartIndex index, Object value)
void	putValueEntry(KKey key, ValueIndex valueIndex, Object value)
void	setHierarchy(AqdefHierarchy hierarchy)

Methods inherited from class java.lang.Object

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

Constructor Detail

AqdefObjectModel

public AqdefObjectModel()

Method Detail

putPartEntry

public void putPartEntry(KKey key,
                         PartIndex index,
                         Object value)

putCharacteristicEntry

public void putCharacteristicEntry(KKey key,
                                   CharacteristicIndex characteristicIndex,
                                   Object value)

putGroupEntry

public void putGroupEntry(KKey key,
                          GroupIndex groupIndex,
                          Object value)

putValueEntry

public void putValueEntry(KKey key,
                          ValueIndex valueIndex,
                          Object value)

putHierarchyEntry

public void putHierarchyEntry(KKey kKey,
                              Integer nodeIndex,
                              Object value)

getPartIndexes

public List<PartIndex> getPartIndexes()

Returns indexes of all parts in this object model.

Returns:

getPartEntries

public AqdefObjectModel.PartEntries getPartEntries(int index)

getPartEntries

public AqdefObjectModel.PartEntries getPartEntries(PartIndex index)

getCharacteristicIndexes

public List<CharacteristicIndex> getCharacteristicIndexes(PartIndex partIndex)

Returns indexes of all characteristics of a part with the given index.

Returns:

getCharacteristicEntries

public AqdefObjectModel.CharacteristicEntries getCharacteristicEntries(int partIndex,
                                                                       int characteristicIndex)

getCharacteristicEntries

public AqdefObjectModel.CharacteristicEntries getCharacteristicEntries(CharacteristicIndex characteristicIndex)

getValueIndexes

public List<ValueIndex> getValueIndexes(CharacteristicIndex characteristicIndex)

Returns indexes of all values of a characteristics with the given index.

Returns:

getValueIndexes

public List<ValueIndex> getValueIndexes()

Returns indexes of all values in this object model.

Returns:

getValueEntries

public AqdefObjectModel.ValueEntries getValueEntries(int partIndex,
                                                     int characteristicIndex,
                                                     int valueIndex)

getValueEntries

public AqdefObjectModel.ValueEntries getValueEntries(ValueIndex valueIndex)

getValueEntries

public List<AqdefObjectModel.ValueEntries> getValueEntries(CharacteristicIndex characteristicIndex)

getValueSets

public List<AqdefObjectModel.ValueSet> getValueSets(PartIndex partIndex)

findPartIndexForCharacteristic

public PartIndex findPartIndexForCharacteristic(int characteristicIndex)

Finds part index to which the given characteristic index belongs.

You should call this method only after this AqdefObjectModel is fully created.

Parameters:

characteristicIndex -

Returns:

findCharacteristicIndexesForPart

public Set<CharacteristicIndex> findCharacteristicIndexesForPart(PartIndex partIndex,
                                                                 AqdefObjectModel.CharacteristicOfSinglePartPredicate predicate)

forEachPart

public void forEachPart(AqdefObjectModel.PartConsumer consumer)

Iterates through all parts

Parameters:

consumer -

forEachCharacteristic

public void forEachCharacteristic(AqdefObjectModel.CharacteristicConsumer consumer)

Iterates through all characteristics of all parts

Parameters:

consumer -

forEachCharacteristic

public void forEachCharacteristic(AqdefObjectModel.PartEntries part,
                                  AqdefObjectModel.CharacteristicOfSinglePartConsumer consumer)

Iterates through all characteristics of the given part. Most of the time it will be used together with forEachPart(PartConsumer).

 model.forEachPart(part -> {
     // do something with the part

     model.forEachCharacteristic(part, characteristic -> {
         // do something with the characteristic
     });
 })
 

Parameters:

part -

consumer -

forEachGroup

public void forEachGroup(AqdefObjectModel.GroupConsumer consumer)

Iterates through all logical groups of all parts

Parameters:

consumer -

forEachGroup

public void forEachGroup(AqdefObjectModel.PartEntries part,
                         AqdefObjectModel.GroupOfSinglePartConsumer consumer)

Iterates through all logical groups of the given part. Similar to forEachCharacteristic(PartEntries, CharacteristicOfSinglePartConsumer)

Parameters:

part -

consumer -

forEachValue

public void forEachValue(AqdefObjectModel.ValueConsumer consumer)

Iterates through all values.

Parameters:

consumer -

forEachValue

public void forEachValue(AqdefObjectModel.PartEntries part,
                         AqdefObjectModel.ValueOfSinglePartConsumer consumer)

Iterates through all values of the given part. Most of the time it will be used together with forEachPart(PartConsumer).

 model.forEachPart(part -> {
     // do something with the part

     model.forEachValue(part, (characteristic, value) -> {
         // do something with the value
     });
 })
 

Parameters:

part -

consumer -

forEachValue

public void forEachValue(AqdefObjectModel.PartEntries part,
                         AqdefObjectModel.CharacteristicEntries characteristic,
                         AqdefObjectModel.ValueOfSingleCharacteristicConsumer consumer)

Iterates through all values of the given characteristic. Most of the time it will be used together with forEachCharacteristic(CharacteristicConsumer).

 model.forEachCharacteristic(part, characteristic -> {
     // do something with the characteristic

     model.forEachValue(part, characteristic, value -> {
         // do something with the value
     });
 })
 

Parameters:

part -

characteristic -

consumer -

filterParts

public void filterParts(AqdefObjectModel.PartPredicate predicate)

Removes all parts that do not match the given predicate. If a part is removed it's characteristics and values are also removed.

Parameters:

predicate -

filterCharacteristics

public void filterCharacteristics(AqdefObjectModel.CharacteristicPredicate predicate)

Removes all characteristics that do not match the given predicate. If a characteristic is removed it's values are also removed.

Parameters:

predicate -

filterCharacteristics

public void filterCharacteristics(AqdefObjectModel.PartEntries part,
                                  AqdefObjectModel.CharacteristicOfSinglePartPredicate predicate)

Removes all characteristics of the given part that do not match the given predicate. If a characteristic is removed it's values are also removed.

Parameters:

part -

predicate -

filterValues

public void filterValues(AqdefObjectModel.ValuePredicate predicate)

Removes all values that do not match the given predicate.

Parameters:

predicate -

filterValues

public void filterValues(AqdefObjectModel.PartEntries part,
                         AqdefObjectModel.ValueOfSinglePartPredicate predicate)

Removes all values of the given part that do not match the given predicate.

Parameters:

part -

predicate -

filterValues

public void filterValues(AqdefObjectModel.PartEntries part,
                         AqdefObjectModel.CharacteristicEntries characteristic,
                         AqdefObjectModel.ValueOfSinglePartPredicate predicate)

Removes all values of the given characteristic that do not match the given predicate.

Parameters:

part -

characteristic -

predicate -

getAnyValueOf

public Object getAnyValueOf(KKey key)

Finds value of the given K-key from any part / characteristic / value.

There is no guarantee from which part / characteristic / value this K-key value will be taken (whether from the first or other).

Parameters:

key - any K-key of part / characteristic / value

Returns:

Throws:

IllegalArgumentException - if the K-key is not for part / characteristic / value lavel.

normalize

public void normalize()

Apply all /0 K-keys on all parts / characteristics / values and then remove them from object model.

getCharacteristicCount

public int getCharacteristicCount()

Returns total number of characteristics of all parts in this object model

Returns:

getValueCount

public int getValueCount()

Returns total number of values of all parts and characteristics in this object model

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getHierarchy

public AqdefHierarchy getHierarchy()

setHierarchy

public void setHierarchy(AqdefHierarchy hierarchy)