org.cip4.jdflib.extensions

Class SetHelper

java.lang.Object

org.cip4.jdflib.extensions.BaseXJDFHelper

org.cip4.jdflib.extensions.SetHelper

All Implemented Interfaces:

IMatches

public class SetHelper
extends BaseXJDFHelper
implements IMatches

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SetHelper.EnumFamily

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAMETER_SET
static java.lang.String	RESOURCE_SET
static java.lang.String	SET

Fields inherited from class org.cip4.jdflib.extensions.BaseXJDFHelper

log, theElement

Constructor Summary

Constructors

Constructor and Description
SetHelper(KElement set)

Method Summary

Modifier and Type	Method and Description
void	addTypeToCPI(int pos) add a CPI process
ResourceHelper	appendPartition(JDFAttributeMap partMap, boolean addRes)
ResourceHelper	appendPartition(java.lang.String partKey, java.lang.String partValue, boolean addRes) convenience ...
ResourceHelper	appendResource(VJDFAttributeMap partMaps, boolean addRes)
void	cleanUp() generic cleanup routine
double	getAmountSum(boolean bGood)
JDFIntegerList	getCombinedProcessIndex()
ResourceHelper	getCreateExactPartition(JDFAttributeMap map, boolean addRes) get an existing partition with at least a matching partmap
ResourceHelper	getCreatePartition(int index, boolean addRes)
ResourceHelper	getCreatePartition(JDFAttributeMap map, boolean addRes)
ResourceHelper	getCreatePartition(java.lang.String partKey, java.lang.String partValue, boolean addRes) convenience ...
java.util.Vector<ResourceHelper>	getCreatePartitions(VJDFAttributeMap vmap, boolean addRes) creates 1 partition for each entry in the map
ResourceHelper	getCreateVPartition(VJDFAttributeMap vmap, boolean addRes) get an existing partition with at least a matching partmap
VString	getDependentJobParts()
java.lang.String	getDescriptiveName()
ResourceHelper	getExactPartition(JDFAttributeMap map)
java.lang.String	getExternalID()
SetHelper.EnumFamily	getFamily()
static SetHelper	getHelper(KElement e) factory to create a helper from an element
java.lang.String	getName()
ResourceHelper	getPartition(int index)
ResourceHelper	getPartition(JDFAttributeMap map)
ResourceHelper	getPartition(java.lang.String id) get a partition by id
ResourceHelper	getPartition(java.lang.String key, java.lang.String value)
ResourceHelper	getPartition(VJDFAttributeMap vmap)
java.util.List<ResourceHelper>	getPartitionList()
java.lang.String	getPartitionName()
java.util.Vector<ResourceHelper>	getPartitions()
java.util.Vector<ResourceHelper>	getPartitions(JDFAttributeMap map)
java.util.Vector<ResourceHelper>	getPartitions(VJDFAttributeMap vmap)
VJDFAttributeMap	getPartMapVector() returns the unified partmaps
java.util.Collection<VJDFAttributeMap>	getPartMapVectors()
java.lang.String	getProcessUsage()
KElement	getSet()
static java.lang.String	getSetName(KElement e)
static java.lang.String	getSetName(java.lang.String setName)
java.util.Vector<ResourceHelper>	getSuperPartitions(JDFAttributeMap map) returns all partitions that are a superset of map
JDFResourceLink.EnumUsage	getUsage()
XJDFHelper	getXJDF()
int	indexOf(ResourceHelper bsHelper)
ResourceHelper	insertPartitionBefore(ResourceHelper e, JDFAttributeMap map, boolean addRes)
static boolean	isSet(KElement e) is the element a set?
static boolean	isSet(java.lang.String localName) is the element name a set?
boolean	matches(java.lang.Object subset) returns true if subset somehow matches this the semantics are defined by the filtering algorithm, thus it could be a filter or a subset i.e.
void	removeIDs()
void	removePartitions() remove all partitions in this set
void	removeTypeFromCPI(int pos) remove a CPI process
void	setCombinedProcessIndex(JDFIntegerList cpi)
void	setDescriptiveName(java.lang.String description)
void	setExternalID(java.lang.String newID)
void	setGeneralID(java.lang.String idUsage, java.lang.String idValue)
void	setID(java.lang.String newID)
void	setName(java.lang.String name)
void	setProcessUsage(java.lang.String processUsage)
void	setUsage(JDFResourceLink.EnumUsage value)
java.lang.String	toString()

Methods inherited from class org.cip4.jdflib.extensions.BaseXJDFHelper

appendElement, appendElement, copyHelper, deleteNode, ensureID, equals, getAttribute, getAttributeMap, getBaseHelper, getBaseHelper, getComment, getCreateElement, getDefaultVersion, getGeneralID, getID, getLocalName, getRoot, getXJDFRoot, getXPathElement, getXPathValue, getXRoot, hasAttribute, hashCode, isEqual, removeAttribute, setAttribute, setComment, setDefaultVersion, setXPathValue

Methods inherited from class java.lang.Object

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

Field Detail

SET

public static final java.lang.String SET

See Also:

Constant Field Values

PARAMETER_SET

public static final java.lang.String PARAMETER_SET

RESOURCE_SET

public static final java.lang.String RESOURCE_SET

See Also:

Constant Field Values

Constructor Detail

SetHelper

public SetHelper(KElement set)

Parameters:

set - the set to help on

Method Detail

getAmountSum

public double getAmountSum(boolean bGood)

Parameters:

bGood - good=true

Returns:

isSet

public static boolean isSet(KElement e)

is the element a set?

Parameters:

e -

Returns:

isSet

public static boolean isSet(java.lang.String localName)

is the element name a set?

Parameters:

localName -

Returns:

getPartition

public ResourceHelper getPartition(JDFAttributeMap map)

Parameters:

map -

Returns:

getPartition

public ResourceHelper getPartition(java.lang.String key,
                                   java.lang.String value)

Parameters:

map -

Returns:

getPartition

public ResourceHelper getPartition(int index)

Parameters:

index -

Returns:

getCreatePartition

public ResourceHelper getCreatePartition(JDFAttributeMap map,
                                         boolean addRes)

Parameters:

map -

addRes -

Returns:

getCreateVPartition

public ResourceHelper getCreateVPartition(VJDFAttributeMap vmap,
                                          boolean addRes)

get an existing partition with at least a matching partmap

Parameters:

vmap -

addRes -

Returns:

getCreateExactPartition

public ResourceHelper getCreateExactPartition(JDFAttributeMap map,
                                              boolean addRes)

get an existing partition with at least a matching partmap

Parameters:

vmap -

addRes -

Returns:

getExactPartition

public ResourceHelper getExactPartition(JDFAttributeMap map)

Parameters:

map -

Returns:

insertPartitionBefore

public ResourceHelper insertPartitionBefore(ResourceHelper e,
                                            JDFAttributeMap map,
                                            boolean addRes)

Parameters:

e -

map -

addRes -

Returns:

getCreatePartitions

public java.util.Vector<ResourceHelper> getCreatePartitions(VJDFAttributeMap vmap,
                                                            boolean addRes)

creates 1 partition for each entry in the map

Parameters:

vmap -

addRes -

Returns:

getCreatePartition

public ResourceHelper getCreatePartition(int index,
                                         boolean addRes)

Parameters:

index -

addRes -

Returns:

removePartitions

public void removePartitions()

remove all partitions in this set

appendPartition

public ResourceHelper appendPartition(java.lang.String partKey,
                                      java.lang.String partValue,
                                      boolean addRes)

convenience ... @see appendPartition(JDFAttributeMap, boolean)

Parameters:

partKey -

partValue -

addRes -

Returns:

getCreatePartition

public ResourceHelper getCreatePartition(java.lang.String partKey,
                                         java.lang.String partValue,
                                         boolean addRes)

convenience ... @see getCreatePartition(JDFAttributeMap, boolean)

Parameters:

partKey -

partValue -

addRes -

Returns:

appendPartition

public ResourceHelper appendPartition(JDFAttributeMap partMap,
                                      boolean addRes)

Parameters:

partMap -

addRes - if true, also add the detailed resource element, e.g. Layout

Returns:

appendResource

public ResourceHelper appendResource(VJDFAttributeMap partMaps,
                                     boolean addRes)

Parameters:

partMap -

addRes - if true, also add the detailed resource element, e.g. Layout

Returns:

getXJDF

public XJDFHelper getXJDF()

Returns:

getPartitions

public java.util.Vector<ResourceHelper> getPartitions()

Returns:

the vector of partition helpers

getPartitionList

public java.util.List<ResourceHelper> getPartitionList()

Returns:

the vector of partition helpers

cleanUp

public void cleanUp()

Description copied from class: BaseXJDFHelper

generic cleanup routine

Overrides:

cleanUp in class BaseXJDFHelper

getName

public java.lang.String getName()

Returns:

the name of the resource set also fixes it in case it needs to be calculated from kids

getPartitionName

public java.lang.String getPartitionName()

Returns:

getSetName

public static java.lang.String getSetName(KElement e)

Parameters:

e - the element to test

Returns:

then asset type name (Parameter, Resource etc)

getSetName

public static java.lang.String getSetName(java.lang.String setName)

Parameters:

setName - the name of the set element

Returns:

then asset type name (Parameter, Resource etc)

getPartition

public ResourceHelper getPartition(VJDFAttributeMap vmap)

Parameters:

vmap -

Returns:

getPartitions

public java.util.Vector<ResourceHelper> getPartitions(VJDFAttributeMap vmap)

Parameters:

vmap -

Returns:

getPartitions

public java.util.Vector<ResourceHelper> getPartitions(JDFAttributeMap map)

Parameters:

map -

Returns:

getSuperPartitions

public java.util.Vector<ResourceHelper> getSuperPartitions(JDFAttributeMap map)

returns all partitions that are a superset of map

Parameters:

map -

Returns:

getSet

public KElement getSet()

Returns:

setUsage

public void setUsage(JDFResourceLink.EnumUsage value)

Parameters:

value -

getUsage

public JDFResourceLink.EnumUsage getUsage()

Returns:

getProcessUsage

public java.lang.String getProcessUsage()

Returns:

getCombinedProcessIndex

public JDFIntegerList getCombinedProcessIndex()

Returns:

removeTypeFromCPI

public void removeTypeFromCPI(int pos)

remove a CPI process

Parameters:

typ -

pos -

addTypeToCPI

public void addTypeToCPI(int pos)

add a CPI process

Parameters:

typ -

pos -

setCombinedProcessIndex

public void setCombinedProcessIndex(JDFIntegerList cpi)

setProcessUsage

public void setProcessUsage(java.lang.String processUsage)

getDescriptiveName

public java.lang.String getDescriptiveName()

Overrides:

getDescriptiveName in class BaseXJDFHelper

Returns:

getExternalID

public java.lang.String getExternalID()

Overrides:

getExternalID in class BaseXJDFHelper

Returns:

the productID of the product

toString

public java.lang.String toString()

Overrides:

toString in class BaseXJDFHelper

Returns:

See Also:

Object.toString()

getPartition

public ResourceHelper getPartition(java.lang.String id)

get a partition by id

Parameters:

id -

Returns:

getFamily

public SetHelper.EnumFamily getFamily()

Returns:

setID

public void setID(java.lang.String newID)

Overrides:

setID in class BaseXJDFHelper

See Also:

BaseXJDFHelper.setID(java.lang.String)

getPartMapVector

public VJDFAttributeMap getPartMapVector()

returns the unified partmaps

Returns:

getPartMapVectors

public java.util.Collection<VJDFAttributeMap> getPartMapVectors()

Returns:

the ordered collection of PartMapVectors of each child resource

getDependentJobParts

public VString getDependentJobParts()

Returns:

setName

public void setName(java.lang.String name)

Parameters:

name -

removeIDs

public void removeIDs()

indexOf

public int indexOf(ResourceHelper bsHelper)

Parameters:

bsHelper -

Returns:

getHelper

public static SetHelper getHelper(KElement e)

factory to create a helper from an element

Parameters:

root - the element to parse

Returns:

the helper

setExternalID

public void setExternalID(java.lang.String newID)

See Also:

BaseXJDFHelper.setExternalID(java.lang.String)

setDescriptiveName

public void setDescriptiveName(java.lang.String description)

See Also:

BaseXJDFHelper.setDescriptiveName(java.lang.String)

setGeneralID

public void setGeneralID(java.lang.String idUsage,
                         java.lang.String idValue)

See Also:

BaseXJDFHelper.setGeneralID(java.lang.String, java.lang.String)

matches

public boolean matches(java.lang.Object subset)

Description copied from interface: IMatches

returns true if subset somehow matches this the semantics are defined by the filtering algorithm, thus it could be a filter or a subset i.e. subset contains either equivalent elements or null and no non-matching elements matches(null) always returns true

Specified by:

matches in interface IMatches

Parameters:

subset - the object to filter against

Returns:

true if it matches