org.cip4.jdflib.extensions

Class ResourceHelper

java.lang.Object

org.cip4.jdflib.extensions.BaseXJDFHelper

org.cip4.jdflib.extensions.ResourceHelper

All Implemented Interfaces:

IAmountPoolContainer

Direct Known Subclasses:

PartitionHelper

public class ResourceHelper
extends BaseXJDFHelper
implements IAmountPoolContainer

Author:

Rainer Prosi, Heidelberger Druckmaschinen *

Field Summary

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

log, theElement

Constructor Summary

Constructors

Constructor and Description
ResourceHelper(KElement partition)

Method Summary

Modifier and Type	Method and Description
void	appendPartMap(JDFAttributeMap part)
void	appendPartMapVector(VJDFAttributeMap vPart)
void	cleanUp() generic cleanup stuff
boolean	containsMap(JDFAttributeMap map)
ResourceHelper	ensurePart(String key, String value)
JDFAmountPool	getAmountPool()
String	getAttribute(String attrib, String nameSpaceURI, String def)
String	getBrand()
JDFAmountPool	getCreateAmountPool()
KElement	getCreateResource()
String	getExternalID()
static ResourceHelper	getHelper(KElement res) factory to create a helper from an element
JDFResource	getLinkRoot()
KElement	getPartition()
JDFAttributeMap	getPartMap() convenience to get the partmap of the first (and typically only) part element
VJDFAttributeMap	getPartMapVector()
double	getRealAttribute(String attName, String namespace, double def)
KElement	getResource()
SetHelper	getSet()
JDFResource.EnumResStatus	getStatus()
XJDFHelper	getXJDF()
boolean	hasAttribute(String attName)
static boolean	isAsset(KElement toCheck)
static boolean	isAsset(KElement toCheck, String resName)
static boolean	isResourceElement(KElement toCheck)
boolean	matches(JDFAttributeMap map)
boolean	matches(VJDFAttributeMap vmap)
void	setAmount(double amount, JDFAttributeMap moreMap, boolean bGood)
void	setAttribute(String attrib, String value, String nameSpaceURI)
void	setBrand(String brand)
void	setExternalID(String externalID)
void	setPartMap(JDFAttributeMap map)
void	setPartMapVector(VJDFAttributeMap vPart)
void	setStatus(JDFResource.EnumResStatus status)
void	setVAmount(double amount, VJDFAttributeMap moreMaps, boolean bGood)
String	toString()

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

appendElement, copyHelper, deleteNode, ensureID, equals, getAttribute, getCreateElement, getGeneralID, getID, getRoot, getXPathElement, getXPathValue, hashCode, isEqual, removeAttribute, reorder, setAttribute, setGeneralID, setID, setXPathValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cip4.jdflib.ifaces.IAmountPoolContainer

removeAttribute

Constructor Detail

ResourceHelper

public ResourceHelper(KElement partition)

Parameters:

partition -

Method Detail

isAsset

public static boolean isAsset(KElement toCheck)

Parameters:

toCheck -

Returns:

true if toCheck is an asset (Resource, Parameter...)

isAsset

public static boolean isAsset(KElement toCheck,
                              String resName)

Parameters:

toCheck -

Returns:

true if toCheck is an asset (Resource, Parameter...)

isResourceElement

public static boolean isResourceElement(KElement toCheck)

Parameters:

toCheck -

Returns:

true if toCheck is an explicit resource element (Media, RunList, ...)

getHelper

public static ResourceHelper getHelper(KElement res)

factory to create a helper from an element

Parameters:

res - the element to parseeither a "Resource" or a resource element

Returns:

the helper

getPartMapVector

public VJDFAttributeMap getPartMapVector()

Specified by:

getPartMapVector in interface IAmountPoolContainer

Returns:

getPartMap

public JDFAttributeMap getPartMap()

convenience to get the partmap of the first (and typically only) part element

Returns:

one non-null part element that may be empty

setPartMap

public void setPartMap(JDFAttributeMap map)

Parameters:

map - the partmap to set the part element

ensurePart

public ResourceHelper ensurePart(String key,
                                 String value)

Parameters:

key -

value -

Returns:

this - useful for lazy chaining

setPartMapVector

public void setPartMapVector(VJDFAttributeMap vPart)

Parameters:

vPart - the vector of partmaps to set the part element

appendPartMapVector

public void appendPartMapVector(VJDFAttributeMap vPart)

Parameters:

vPart - the vector of partmaps to set the part element

appendPartMap

public void appendPartMap(JDFAttributeMap part)

Parameters:

part -

matches

public boolean matches(JDFAttributeMap map)

Parameters:

map -

Returns:

containsMap

public boolean containsMap(JDFAttributeMap map)

Parameters:

map -

Returns:

matches

public boolean matches(VJDFAttributeMap vmap)

Parameters:

vmap -

Returns:

getPartition

public KElement getPartition()

Returns:

the generic Parameter or Resource element

getSet

public SetHelper getSet()

Returns:

the parent set

getXJDF

public XJDFHelper getXJDF()

Returns:

setAmount

public void setAmount(double amount,
                      JDFAttributeMap moreMap,
                      boolean bGood)

Parameters:

amount -

moreMap -

bGood -

setVAmount

public void setVAmount(double amount,
                       VJDFAttributeMap moreMaps,
                       boolean bGood)

Parameters:

amount -

moreMap -

bGood -

getResource

public KElement getResource()

Returns:

the actual detailed resource

getCreateResource

public KElement getCreateResource()

Returns:

toString

public String toString()

Overrides:

toString in class BaseXJDFHelper

Returns:

See Also:

Object.toString()

cleanUp

public void cleanUp()

generic cleanup stuff

Overrides:

cleanUp in class BaseXJDFHelper

getAmountPool

public JDFAmountPool getAmountPool()

Specified by:

getAmountPool in interface IAmountPoolContainer

Returns:

the matching amountpool

See Also:

IAmountPoolContainer.getAmountPool()

getAttribute

public String getAttribute(String attrib,
                           String nameSpaceURI,
                           String def)

Specified by:

getAttribute in interface IAmountPoolContainer

Returns:

See Also:

IAmountPoolContainer.getAttribute(java.lang.String, java.lang.String, java.lang.String)

getRealAttribute

public double getRealAttribute(String attName,
                               String namespace,
                               double def)

Specified by:

getRealAttribute in interface IAmountPoolContainer

Returns:

See Also:

IAmountPoolContainer.getRealAttribute(java.lang.String, java.lang.String, double)

hasAttribute

public boolean hasAttribute(String attName)

Specified by:

hasAttribute in interface IAmountPoolContainer

Returns:

See Also:

IAmountPoolContainer.hasAttribute(java.lang.String)

getLinkRoot

public JDFResource getLinkRoot()

Specified by:

getLinkRoot in interface IAmountPoolContainer

Returns:

See Also:

IAmountPoolContainer.getLinkRoot()

setAttribute

public void setAttribute(String attrib,
                         String value,
                         String nameSpaceURI)

Specified by:

setAttribute in interface IAmountPoolContainer

See Also:

IAmountPoolContainer.setAttribute(java.lang.String, java.lang.String, java.lang.String)

getCreateAmountPool

public JDFAmountPool getCreateAmountPool()

Specified by:

getCreateAmountPool in interface IAmountPoolContainer

Returns:

the AmountPool

See Also:

IAmountPoolContainer.getCreateAmountPool()

setBrand

public void setBrand(String brand)

Parameters:

brand -

getBrand

public String getBrand()

Returns:

the brand

setExternalID

public void setExternalID(String externalID)

Parameters:

externalID -

getExternalID

public String getExternalID()

Returns:

the externalID

setStatus

public void setStatus(JDFResource.EnumResStatus status)

Parameters:

available -

getStatus

public JDFResource.EnumResStatus getStatus()

Returns:

the res status enum