org.cip4.jdflib.extensions

Class SetHelper

java.lang.Object

org.cip4.jdflib.extensions.BaseXJDFHelper

org.cip4.jdflib.extensions.SetHelper

public class SetHelper
extends BaseXJDFHelper

Author:

Rainer Prosi, Heidelberger Druckmaschinen *

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 String	PARAMETER_SET
static String	RESOURCE_SET
static String	SET

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

log, theElement

Constructor Summary

Constructors

Constructor and Description
SetHelper(KElement set)

Method Summary

Methods

Modifier and Type	Method and Description
PartitionHelper	appendPartition(JDFAttributeMap partMap, boolean addRes)
void	cleanUp() generic cleanup routine
PartitionHelper	getCreatePartition(int index, boolean addRes)
PartitionHelper	getCreatePartition(JDFAttributeMap map, boolean addRes)
Vector<PartitionHelper>	getCreatePartitions(VJDFAttributeMap vmap, boolean addRes)
SetHelper.EnumFamily	getFamily()
String	getName()
PartitionHelper	getPartition(int index)
PartitionHelper	getPartition(JDFAttributeMap map)
PartitionHelper	getPartition(String id) get a partition by id
PartitionHelper	getPartition(VJDFAttributeMap vmap)
String	getPartitionName()
Vector<PartitionHelper>	getPartitions()
String	getProcessUsage()
KElement	getSet()
static String	getSetName(KElement e)
static String	getSetName(String setName)
JDFResourceLink.EnumUsage	getUsage()
PartitionHelper	insertPartitionBefore(PartitionHelper e, JDFAttributeMap map, boolean addRes)
static boolean	isSet(KElement e) is the element a set?
static boolean	isSet(String localName) is the element name a set?
void	removePartitions() remove all partitions in this set
void	setID(String newID)
void	setProcessUsage(String processUsage)
void	setUsage(JDFResourceLink.EnumUsage value)
String	toString()

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

deleteNode, equals, getID, getRoot, getXPathValue, hashCode, isEqual, reorder, setXPathValue

Methods inherited from class java.lang.Object

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

Field Detail

SET

public static final String SET

See Also:

Constant Field Values

PARAMETER_SET

public static final String PARAMETER_SET

RESOURCE_SET

public static final String RESOURCE_SET

Constructor Detail

SetHelper

public SetHelper(KElement set)

Parameters:

set - the set to help on

Method Detail

isSet

public static boolean isSet(KElement e)

is the element a set?

Parameters:

e -

Returns:

isSet

public static boolean isSet(String localName)

is the element name a set?

Parameters:

localName -

Returns:

getPartition

public PartitionHelper getPartition(JDFAttributeMap map)

Parameters:

map -

Returns:

getPartition

public PartitionHelper getPartition(int index)

Parameters:

index -

Returns:

getCreatePartition

public PartitionHelper getCreatePartition(JDFAttributeMap map,
                                 boolean addRes)

Parameters:

map -

addRes -

Returns:

insertPartitionBefore

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

Parameters:

e -

map -

addRes -

Returns:

getCreatePartitions

public Vector<PartitionHelper> getCreatePartitions(VJDFAttributeMap vmap,
                                          boolean addRes)

Parameters:

vmap -

addRes -

Returns:

getCreatePartition

public PartitionHelper getCreatePartition(int index,
                                 boolean addRes)

Parameters:

index -

addRes -

Returns:

removePartitions

public void removePartitions()

remove all partitions in this set

appendPartition

public PartitionHelper appendPartition(JDFAttributeMap partMap,
                              boolean addRes)

Parameters:

partMap -

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

Returns:

getPartitions

public Vector<PartitionHelper> getPartitions()

Returns:

the vector of partition helpers

cleanUp

public void cleanUp()

Description copied from class: BaseXJDFHelper

generic cleanup routine

Specified by:

cleanUp in class BaseXJDFHelper

getName

public String getName()

Returns:

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

getPartitionName

public String getPartitionName()

Returns:

getSetName

public static String getSetName(KElement e)

Parameters:

e - the element to test

Returns:

then asset type name (Parameter, Resource etc)

getSetName

public static String getSetName(String setName)

Parameters:

setName - the name of the set element

Returns:

then asset type name (Parameter, Resource etc)

getPartition

public PartitionHelper getPartition(VJDFAttributeMap vmap)

Parameters:

vmap -

Returns:

getSet

public KElement getSet()

Returns:

setUsage

public void setUsage(JDFResourceLink.EnumUsage value)

Parameters:

value -

getUsage

public JDFResourceLink.EnumUsage getUsage()

Returns:

getProcessUsage

public String getProcessUsage()

Returns:

setProcessUsage

public void setProcessUsage(String processUsage)

toString

public String toString()

Overrides:

toString in class Object

Returns:

See Also:

Object.toString()

getPartition

public PartitionHelper getPartition(String id)

get a partition by id

Parameters:

id -

Returns:

getFamily

public SetHelper.EnumFamily getFamily()

Returns:

setID

public void setID(String newID)

Overrides:

setID in class BaseXJDFHelper

See Also:

BaseXJDFHelper.setID(java.lang.String)