Package 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

Field Summary

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

log, theElement

Constructor Summary

Constructors

Constructor	Description
ResourceHelper(KElement partition)

Method Summary

Modifier and Type	Method	Description
void	appendPartMap(JDFAttributeMap part)
void	appendPartMapVector(VJDFAttributeMap vPart)
void	cleanUp()	generic cleanup stuff
ResourceHelper	clonePartition()	return a clone of this, placed just behind this
boolean	containsMap(JDFAttributeMap map)
ResourceHelper	ensurePart(java.lang.String key, java.lang.String value)
void	ensureReference(KElement src, java.lang.String key)	ensure a reference *FROM* src
void	ensureReference(ResourceHelper src, java.lang.String key)	ensure a reference *FROM* src's explicit resource
double	getAmount(JDFAttributeMap partMap, boolean bGood)
JDFAmountPool	getAmountPool()
double	getAmountSum(boolean bGood)
java.lang.String	getAttribute(java.lang.String attrib, java.lang.String nameSpaceURI, java.lang.String def)
java.lang.String	getBrand()
java.lang.String	getComment(int i)
JDFAmountPool	getCreateAmountPool()
KElement	getCreateResource()
java.lang.String	getDescriptiveName()
java.lang.String	getExternalID()
static ResourceHelper	getHelper(KElement res)	factory to create a helper from an element
JDFResource	getLinkRoot()
java.lang.String	getName()
KElement	getPartition()
java.lang.String	getPartKey(java.lang.String key)	convenience to get the partmap of the first (and typically only) part element
JDFAttributeMap	getPartMap()	convenience to get the partmap of the first (and typically only) part element
java.util.List<JDFAttributeMap>	getPartMapList()
VJDFAttributeMap	getPartMapVector()
double	getRealAttribute(java.lang.String attName, java.lang.String namespace, double def)
KElement	getResource()
java.lang.String	getResourceAttribute(java.lang.String string)
SetHelper	getSet()
JDFResource.EnumResStatus	getStatus()
XJDFHelper	getXJDF()
boolean	hasPartition(JDFAttributeMap exactMap)
static boolean	isAsset(KElement toCheck)
static boolean	isAsset(KElement toCheck, java.lang.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(java.lang.String attrib, java.lang.String value, java.lang.String nameSpaceURI)
void	setBrand(java.lang.String brand)
void	setDescriptiveName(java.lang.String description)
void	setExternalID(java.lang.String externalID)
JDFGeneralID	setGeneralID(java.lang.String idUsage, java.lang.String idValue)
void	setPartMap(JDFAttributeMap map)
void	setPartMapVector(VJDFAttributeMap vPart)
void	setResourceAttribute(java.lang.String attrib, java.lang.String value)
void	setResourceEnum(java.lang.String attrib, org.apache.commons.lang.enums.ValuedEnum value)
void	setStatus(JDFResource.EnumResStatus status)
void	setVAmount(double amount, VJDFAttributeMap moreMaps, boolean bGood)
java.lang.String	toString()

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

appendElement, appendElement, copyHelper, deleteNode, ensureID, equals, getAttribute, getAttributeMap, getBaseHelper, getBaseHelper, getCreateElement, getDefaultVersion, getGeneralID, getID, getLocalName, getRoot, getRootDoc, getVersion, getXJDFRoot, getXJMFRoot, getXPathElement, getXPathValue, getXRoot, hasAttribute, hashCode, isEqual, removeAttribute, setAttribute, setAttribute, setComment, setDefaultVersion, 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

hasAttribute, 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,
                              java.lang.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:

getPartMapList

public java.util.List<JDFAttributeMap> getPartMapList()

Returns:

hasPartition

public boolean hasPartition(JDFAttributeMap exactMap)

Parameters:

exactMap - the map that must be present

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

getPartKey

public java.lang.String getPartKey(java.lang.String key)

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(java.lang.String key,
                                 java.lang.String value)

Parameters:

key -

value -

Returns:

this - useful for lazy chaining

ensureReference

public void ensureReference(KElement src,
                            java.lang.String key)

ensure a reference *FROM* src

Parameters:

src -

key - the reference key in src

ensureReference

public void ensureReference(ResourceHelper src,
                            java.lang.String key)

ensure a reference *FROM* src's explicit resource

Parameters:

src -

key - the reference key in src

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

getName

public java.lang.String getName()

Returns:

the name of this resource - calculated from ResourceSet/@Name

getCreateResource

public KElement getCreateResource()

Returns:

toString

public java.lang.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()

getAmount

public double getAmount(JDFAttributeMap partMap,
                        boolean bGood)

Parameters:

partMap -

Returns:

getAmountSum

public double getAmountSum(boolean bGood)

Parameters:

partMap -

Returns:

getAttribute

public java.lang.String getAttribute(java.lang.String attrib,
                                     java.lang.String nameSpaceURI,
                                     java.lang.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(java.lang.String attName,
                               java.lang.String namespace,
                               double def)

Specified by:

getRealAttribute in interface IAmountPoolContainer

Returns:

See Also:

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

getLinkRoot

public JDFResource getLinkRoot()

Specified by:

getLinkRoot in interface IAmountPoolContainer

Returns:

See Also:

IAmountPoolContainer.getLinkRoot()

setAttribute

public void setAttribute(java.lang.String attrib,
                         java.lang.String value,
                         java.lang.String nameSpaceURI)

Specified by:

setAttribute in interface IAmountPoolContainer

See Also:

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

setResourceAttribute

public void setResourceAttribute(java.lang.String attrib,
                                 java.lang.String value)

setResourceEnum

public void setResourceEnum(java.lang.String attrib,
                            org.apache.commons.lang.enums.ValuedEnum value)

getCreateAmountPool

public JDFAmountPool getCreateAmountPool()

Specified by:

getCreateAmountPool in interface IAmountPoolContainer

Returns:

the AmountPool

See Also:

IAmountPoolContainer.getCreateAmountPool()

setBrand

public void setBrand(java.lang.String brand)

Parameters:

brand -

getBrand

public java.lang.String getBrand()

Returns:

the brand

getComment

public java.lang.String getComment(int i)

Overrides:

getComment in class BaseXJDFHelper

Returns:

the comment text

setExternalID

public void setExternalID(java.lang.String externalID)

Parameters:

externalID -

getDescriptiveName

public java.lang.String getDescriptiveName()

Overrides:

getDescriptiveName in class BaseXJDFHelper

Returns:

the descriptive name of the product

getExternalID

public java.lang.String getExternalID()

Overrides:

getExternalID in class BaseXJDFHelper

Returns:

the productID of the product

setStatus

public void setStatus(JDFResource.EnumResStatus status)

Parameters:

available -

getStatus

public JDFResource.EnumResStatus getStatus()

Returns:

the res status enum

setDescriptiveName

public void setDescriptiveName(java.lang.String description)

See Also:

BaseXJDFHelper.setDescriptiveName(java.lang.String)

setGeneralID

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

See Also:

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

getResourceAttribute

public java.lang.String getResourceAttribute(java.lang.String string)

Parameters:

string -

Returns:

the attribute of the detailed resource, null if empty

clonePartition

public ResourceHelper clonePartition()

return a clone of this, placed just behind this

Returns: