org.cip4.jdflib.resource.devicecapability

Class JDFAbstractState

java.lang.Object

org.apache.xerces.dom.NodeImpl

org.apache.xerces.dom.ChildNode

org.apache.xerces.dom.ParentNode

org.apache.xerces.dom.ElementImpl

org.apache.xerces.dom.ElementNSImpl

org.cip4.jdflib.core.KElement

org.cip4.jdflib.core.JDFElement

org.cip4.jdflib.resource.devicecapability.JDFAbstractState

All Implemented Interfaces:

Serializable, Cloneable, JDFBaseDataTypes, ICapabilityElement, Element, EventTarget, Node, NodeList, TypeInfo

Direct Known Subclasses:

JDFBooleanState, JDFDateTimeState, JDFDurationState, JDFEnumerationState, JDFIntegerState, JDFMatrixState, JDFNameState, JDFNumberState, JDFPDFPathState, JDFRectangleState, JDFShapeState, JDFStringState, JDFXYPairState

public abstract class JDFAbstractState
extends JDFElement
implements JDFBaseDataTypes, ICapabilityElement

Author:

Dr. Rainer Prosi, Heidelberger Druckmaschinen AG befoer June 7, 2009

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JDFAbstractState.EnumUserDisplay

Nested classes/interfaces inherited from class org.cip4.jdflib.core.JDFElement

JDFElement.EnumBoolean, JDFElement.EnumNamedColor, JDFElement.EnumNodeStatus, JDFElement.EnumOrientation, JDFElement.EnumPoolType, JDFElement.EnumSeparation, JDFElement.EnumSettingsPolicy, JDFElement.EnumValidationLevel, JDFElement.EnumVersion, JDFElement.EnumXYRelation

Nested classes/interfaces inherited from class org.cip4.jdflib.core.KElement

KElement.SimpleNodeComparator, KElement.SingleAttributeComparator, KElement.SingleXPathComparator

Nested classes/interfaces inherited from interface org.cip4.jdflib.datatypes.JDFBaseDataTypes

JDFBaseDataTypes.EnumFitsValue

Field Summary

Fields inherited from class org.apache.xerces.dom.ElementNSImpl

localName, namespaceURI

Fields inherited from class org.apache.xerces.dom.ElementImpl

attributes, name

Fields inherited from class org.apache.xerces.dom.ParentNode

firstChild, fNodeListCache, ownerDocument

Fields inherited from class org.apache.xerces.dom.ChildNode

nextSibling, previousSibling

Fields inherited from class org.apache.xerces.dom.NodeImpl

DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE

Fields inherited from interface org.cip4.jdflib.datatypes.JDFBaseDataTypes

EPSILON, MAX_CMYK_COLOR, MAX_LAB_COLOR, MAX_MATRIX_DIMENSION, MAX_RECTANGLE_DIMENSION, MAX_RGB_COLOR, MAX_SHAPE_DIMENSION, MAX_XY_DIMENSION

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from interface org.w3c.dom.TypeInfo

DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION

Constructor Summary

Constructors

Constructor and Description
JDFAbstractState(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String qualifiedName) constructor for JDFAbstractState
JDFAbstractState(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName) constructor for JDFAbstractState
JDFAbstractState(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName, String myLocalName) constructor for JDFAbstractState

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	addValue(String value, JDFBaseDataTypes.EnumFitsValue testlists) add a value to the list of values defined by testlists
JDFLoc	appendLoc() Appends element Loc to the end of this
JDFModuleCap	appendModuleRef(String id) append moduleRef to moduleRefs, if it does not exist, set the availability to module and ensure that the appropriate modulecap exists
JDFValueLoc	appendValueLoc() Appends element ValueLoc
JDFLoc	appendValueLocLoc(int iSkip) appends element Loc to the end of the i-th subelement Value
protected boolean	fitsLength(String str, JDFBaseDataTypes.EnumFitsValue length) fitsLength - tests, if the defined String str matches AllowedLength or the PresentLength, specified for this State
protected boolean	fitsListType(String value) fitsListType - tests, if the defined value matches value of ListType attribute, specified for this State
protected boolean	fitsRegExp(String str, JDFBaseDataTypes.EnumFitsValue regexp) fitsRegExp - checks whether str matches the AllowedRegExp/PresentRegExp specified for this State
abstract boolean	fitsValue(String value, JDFBaseDataTypes.EnumFitsValue testlists) Tests whether the defined value matches the Allowed test lists or the Present test lists specified for this state
VString	getActionRefs() Gets NMTOKENS attribute ActionRefs
protected JDFIntegerRange	getAllowedLength() get attribute AllowedLength
protected String	getAllowedRegExp()
JDFDeviceCap.EnumAvailability	getAvailability() Gets typesafe enumerated attribute Availability
JDFLoc	getCreateLoc(int iSkip) Gets the iSkip-th element Loc.
JDFModulePool	getCreateModulePool() get the ModulePool that contains ModuleCap elements referenced by this create one, if it does not exist
String	getDependentMacroRef() Get string attribute DependentMacroRef
String	getDevNS() Gets URI attribute DevNS
boolean	getEditable() Gets boolean attribute Editable
abstract JDFTerm.EnumTerm	getEvaluationType() get the type of evaluation that is appropriate for this ICapabilityElement
boolean	getHasDefault() Gets boolean attribute HasDefault
protected String	getIDPrefix() getIDPrefix
protected VString	getInvalidAttributesImpl(JDFElement.EnumValidationLevel level, boolean bIgnorePrivate, int nMax)
JDFAutoBasicPreflightTest.EnumListType	getListType() Gets typesafe enumerated attribute ListType
JDFLoc	getLoc(int iSkip) Gets the iSkip-th element Loc
VString	getMacroRefs() Get NMTOKENS attribute MacroRefs
Object	getMatchingObjectInNode(KElement element) gets the matching Attribute value String or AbstractSpan object from the parent, depending on the type of the state
int	getMaxOccurs() Gets integer attribute MaxOccurs
int	getMinOccurs() Get integer attribute MinOccurs
JDFDeviceCap.EnumAvailability	getModuleAvailability() get the availability of this devcaps based on the list of installed modules in ModuleRefs and ModulePool
JDFModulePool	getModulePool() get the ModulePool that contains ModuleCap elements referenced by this
VString	getModuleRefs() (21) get VString attribute ModuleRefs
String	getName() Gets String attribute Name Since name is independent of the data type of the State element,the getter is defined here
String	getNamePath() Gets the NamePath of this State in form " DevCapsName[Context=aaa, LinkUsage=ccc]/DevCapName1/DevCapName2../@StateName "
VString	getNamePathVector()
VString	getNamePathVector(boolean bRecurse) Gets the NamePath of this State in form " DevCapsName[Context=aaa, LinkUsage=ccc]/DevCapName1/DevCapName2../@StateName "
JDFDevCap	getParentDevCap() get the parent devCap of this
JDFDevCaps	getParentDevCaps() get the ancestor devCaps, null if this resides in a DevCapPool
protected JDFIntegerRange	getPresentLength()
protected String	getPresentRegExp()
boolean	getRequired() Gets boolean attribute Required
protected AttributeInfo	getTheAttributeInfo()
protected ElementInfo	getTheElementInfo()
JDFAbstractState.EnumUserDisplay	getUserDisplay() Gets typesafe enumerated attribute UserDisplay
JDFValueLoc	getValueLoc(int iSkip) get iSkip'th element Loc
JDFLoc	getValueLocLoc(int iSkip, int jSkip) Gets the j-th element Loc of the i-th element Value
boolean	init() Method init.
void	setActionRefs(VString value) Sets attribute ActionRefs
protected void	setAllowedLength(JDFIntegerRange value) set attribute AllowedLength
void	setAvailability(JDFDeviceCap.EnumAvailability value) Sets attribute Availability
boolean	setDefaultsFromCaps(KElement element, boolean bAll) set the default values specified in this in element
void	setDependentMacroRef(String value) Sets attribute DependentMacroRef
void	setDevNS(String value) Sets attribute DevNS
void	setEditable(boolean value) Sets attribute Editable
void	setHasDefault(boolean value) Sets attribute HasDefault, default=true
void	setListType(JDFAutoBasicPreflightTest.EnumListType value) Sets attribute ListType, default=SingleValue
void	setMacroRefs(VString value) Sets attribute MacroRefs
void	setMaxOccurs(int value) Sets attribute MaxOccurs,
void	setMinOccurs(int value) Sets attribute MinOccurs, default=1
void	setName(String value) Sets String attribute Name Since name is independent of the data type of the State element, the setter is defined here
protected void	setPresentLength(JDFIntegerRange value)
void	setRequired(boolean value) Sets attribute Required
void	setUserDisplay(JDFAbstractState.EnumUserDisplay value) Sets attribute UserDisplay, default=Display
String	toString() toString

Methods inherited from class org.cip4.jdflib.core.JDFElement

appendAnchor, appendBestEffortExceptions, appendComment, appendElement, appendGeneralID, appendGeneralID, appendGeneralID, appendHRef, appendHRef, appendMustHonorExceptions, appendOperatorInterventionExceptions, appendPreview, appendrRefs, attributeType, clearTargets, cloneNewDoc, copyInto, deprecatedAttributes, eraseDefaultAttributes, exclusiveOneOfAttribute, exclusiveOneOfElement, fixVersion, getAllRefs, getAtrType, getAttributeInfo, getBestEffortExceptions, getChildElement, getChildElements, getChildElementVector_JDFElement, getChildElementVector, getChildIds, getChildrenByTagName, getChildrenByTagName, getChildWithAttribute, getChildWithMatchingAttribute, getComment, getComment, getCommentURL, getCreateComment, getCreatePreview, getCreateRefElement, getDeepElementByID, getDefaultAttributeMap, getDefaultJDFVersion, getDeprecatedAttributes, getDeprecatedElements, getDescriptiveName, getElement_JDFElement, getElement, getElementIDPrefix, getElementNameVector, getEnumAttribute, getEnumerationsAttribute, getEnumerationsAttribute, getEnumforAttribute, getEnumNodeName, getEnumString, getFirstVersion, getGeneralID, getGeneralID, getGeneralID, getGeneralIDMap, getGeneralIDVectorMap, getHRef, getHRefs, getHRefs, getInsertElements, getInsertElementVector, getInvalidAttributes, getInvalidElements_JDFElement, getInvalidElements, getJDFRoot, getJMFRoot, getLastVersion, getLinkRoot, getMaxVersion, getMissingAttributes, getMissingAttributeVector, getMissingElements, getMissingElementVector, getMustHonorExceptions, getNamesVector, getOperatorInterventionExceptions, getOwnerDocument_JDFElement, getParentJDF, getParentJDF, getPartMap, getPartMapVector, getPrereleaseAttributes, getPrereleaseElements, getPreview, getRefElement, getRefElements, getRefString, getrRefs, getSchemaURL, getSchemaURL, getSchemaURL, getSettingsPolicy, getStatus, getTarget_JDFElement, getTarget, getTarget, getTheAttributeInfo_JDFElement, getTheElementInfo_JDFElement, getTypeForAttribute, getUnknownAttributes, getUnknownAttributeVector, getUnknownElements, getUnknownElementVector, getUnknownPoolElements, getURLDoc, getURLInputStream, getValueForNewAttribute, getVersion, getVersion, getvHRefRes, getvHRefRes, getXMLDocUserData, hasMissingAttributes, hasMissingElements, hasPartMap, hasSettingsPolicy, hasUnknownAttributes, hasUnknownElements, idString, includesMatchingAttribute, inlineRefElements, insertBefore, isComment, isCommentStatic, isDeprecated, isDirty, isInJDFNameSpace, isInJDFNameSpaceStatic, isInJDFNameSpaceStatic, isJDFNode, isRefElement, isRefElementStatic, isResource, isResourceLink, isResourceLinkStatic, isResourceStatic, isResourceUpdate, isValid_JDFElement, isValid, jdfVersion, knownAttributes, knownElements, matchesPath, newID, numChildElements_JDFElement, numChildElements, optionalAttributes, optionalElements, prereleaseAttributes, prereleaseElements, refElement, removeBestEffortExceptions, removeChild, removeChild, removeChildren, removeExtensions, removeFromBestEffortExceptions, removeFromMustHonorExceptions, removeFromOperatorInterventionExceptions, removeFromrRefs, removeGeneralID, removePartMap, removeRefElement, removeSettingsPolicy, replaceChild, requiredAttributes, requiredElements, requiredLevel, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeNameTimeStamp, setAttributes, setBestEffortExceptions, setCommentURL, setDefaultJDFVersion, setDescriptiveName, setDirty, setEnumerationsAttribute, setGeneralID, setLongID, setMustHonorExceptions, setOperatorInterventionExceptions, setPartMap, setPartMapVector, setSettingsPolicy, setStatus, setVersion, setvStringAttribute, stringToVersion, uniqueElements, upDaterRefs, validAttribute, validAttribute, validEnumAttribute, validEnumerationsAttribute, validResourcePosition, version, write2Dir

Methods inherited from class org.cip4.jdflib.core.KElement

addAttribute, addAttribute, addNameSpace, ancestorDistance, appendAttribute, appendCData, appendCData, appendChild, appendElement, appendElementN, appendElementRaw, appendEntityReference, appendText, appendTextElement, appendXMLComment, appendXMLComment, buildRelativeXPath, buildXPath, buildXPath, buildXPath, clone, copyAttribute, copyAttribute, copyElement, copyElements, copyXPathValue, createRoot, deleteNode, eraseEmptyAttributes, eraseEmptyNodes, fillHashSet, fitsName_KElement, fitsName, flush, generateDotID, getAttribute_KElement, getAttribute_KElement, getAttribute, getAttribute, getAttributeMap_KElement, getAttributeMap, getAttributeRaw, getAttributeVector_KElement, getAttributeVector, getBoolAttribute, getCData, getChildAttributeList, getChildByTagName, getChildElementArray, getChildElementVector_KElement, getChildElementVector, getChildElementVector, getChildFromList, getChildFromList, getChildNode, getChildNodes_KElement, getChildNodeVector, getChildrenByClass, getChildrenByTagName_KElement, getChildrenFromList, getChildrenIgnoreList, getChildrenWithAttribute, getCreateChildWithAttribute, getCreateElement_KElement, getCreateElement, getCreateElement, getCreateXPathElement, getDeepElement, getDeepParent, getDeepParent, getDeepParentChild, getDeepParentNotName, getDocRoot, getDOMAttr, getElement_KElement, getElement, getElementByClass, getElementHashMap, getElementsByTagName_KElement, getFirstChildElement, getFirstChildElement, getFirstChildElement, getFirstElementNode, getID, getInheritedAttribute, getInheritedElement, getInheritedXPathAttribute, getIntAttribute, getLocalNameStatic, getLongAttribute, getMultipleIDs, getNamespaceURI, getNamespaceURIFromPrefix, getNextElementNode, getNextSiblingElement, getNextSiblingElement, getNextSiblingElement, getNumCDatas, getNumChildNodes, getNumChildText, getNumXMLComments, getOwnerDocument_KElement, getParentNode_KElement, getPreviousSiblingElement, getPreviousSiblingElement, getRealAttribute, getTarget_KElement, getText, getText, getTree, getTreeElement, getXMLComment, getXMLNSNameSpace, getXMLNSPrefix, getXPathAttribute, getXPathAttributeMap, getXPathElement, getXPathElementVector, getXPathValueMap, getXSIType, hasAttribute_KElement, hasAttribute, hasAttribute, hasAttributes, hasChildElement, hasChildElements, hasChildNodes, hasChildText, hasXPathNode, includesAttribute, includesAttributes, insertAt, insertBefore, isAncestor, isEqual, isWildCard, matchesPath, matchesPathName, mergeElement, moveAttribute, moveAttribute, moveElement, moveElements, moveMe, normalize, numChildElements_KElement, numChildNodes, numChildNodes, numChildrenByClass, numSiblingElements, pushUp, removeAllText, removeAttribute_KElement, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeAttributes, removeCData, removeChildNode, removeChildren, removeChildrenByClass, removeChildText, removeExtensions, removeFromAttribute, removeXMLComment, removeXPathAttribute, removeXPathElement, renameAttribute, renameElement, replaceElement, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setAttributeNSRaw, setAttributeRaw, setAttributes, setAttributes, setAttributes, setAttributesRaw, setBoolAttribute, setDirty, setID, setIntAttribute, setNamespaceURI, setNodeValue, setPrefix, setRealAttribute, setText, setvStringAttribute, setXMLComment, setXPathAttribute, setXPathValue, setXPathValues, setXSIType, sortChild, sortChild, sortChildren, sortChildren, toDisplayXML, toXML, toXML, uniqueID, write2File, write2File, write2Stream, xmlNameSpace, xmlnsLocalName, xmlnsPrefix

Methods inherited from class org.apache.xerces.dom.ElementNSImpl

getBaseURI, getLocalName, getPrefix, getTypeName, getTypeNamespace, isDerivedFrom, setType, setValues

Methods inherited from class org.apache.xerces.dom.ElementImpl

cloneNode, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getNodeName, getNodeType, getSchemaTypeInfo, getTagName, getXercesAttribute, hasAttributeNS, isEqualNode, reconcileDefaultAttributes, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setOwnerDocument, setReadOnly, setupDefaultAttributes, setXercesAttributeNode, synchronizeData

Methods inherited from class org.apache.xerces.dom.ParentNode

getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, getTextContent, hasChildNodes, item, setTextContent, synchronizeChildren

Methods inherited from class org.apache.xerces.dom.ChildNode

getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.apache.xerces.dom.NodeImpl

addEventListener, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getContainer, getFeature, getNodeNumber, getNodeValue, getReadOnly, getUserData, getUserData, getUserDataRecord, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setUserData, setUserData

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Element

getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from interface org.w3c.dom.Node

cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasChildNodes, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, setTextContent, setUserData

Constructor Detail

JDFAbstractState

public JDFAbstractState(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                String qualifiedName)

constructor for JDFAbstractState

Parameters:

myOwnerDocument -

qualifiedName -

JDFAbstractState

public JDFAbstractState(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                String myNamespaceURI,
                String qualifiedName)

constructor for JDFAbstractState

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

JDFAbstractState

public JDFAbstractState(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                String myNamespaceURI,
                String qualifiedName,
                String myLocalName)

constructor for JDFAbstractState

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

myLocalName -

Method Detail

getTheAttributeInfo

protected AttributeInfo getTheAttributeInfo()

Overrides:

getTheAttributeInfo in class JDFElement

Returns:

getTheElementInfo

protected ElementInfo getTheElementInfo()

Overrides:

getTheElementInfo in class JDFElement

Returns:

the elementinfo

toString

public String toString()

toString

Overrides:

toString in class JDFElement

Returns:

String

See Also:

Object.toString()

addValue

public abstract void addValue(String value,
            JDFBaseDataTypes.EnumFitsValue testlists)

add a value to the list of values defined by testlists

Parameters:

value - value to test

testlists - switches between Allowed test lists and Present test lists. Has two values: Allowed and Present.

fitsValue

public abstract boolean fitsValue(String value,
                JDFBaseDataTypes.EnumFitsValue testlists)

Tests whether the defined value matches the Allowed test lists or the Present test lists specified for this state

Parameters:

value - value to test

testlists - switches between Allowed test lists and Present test lists. Has two values: Allowed and Present.

Returns:

boolean - true, if the value matches the test lists or if Allowed testlists are not specified

getNamePath

public final String getNamePath()

Gets the NamePath of this State in form " DevCapsName[Context=aaa, LinkUsage=ccc]/DevCapName1/DevCapName2../@StateName "

default getNamePath(false)

Returns:

String - NamePath of this State

getNamePathVector

public final VString getNamePathVector()

Specified by:

getNamePathVector in interface ICapabilityElement

Returns:

See Also:

ICapabilityElement.getNamePathVector()

getNamePathVector

public final VString getNamePathVector(boolean bRecurse)

Gets the NamePath of this State in form " DevCapsName[Context=aaa, LinkUsage=ccc]/DevCapName1/DevCapName2../@StateName "

default getNamePath(false)

Parameters:

bRecurse - if true returns " DevCapsName/SubelemName1/SubelemName2/../@StateName "

Returns:

String - NamePath of this State

getParentDevCaps

public JDFDevCaps getParentDevCaps()

get the ancestor devCaps, null if this resides in a DevCapPool

Returns:

JDFDevCaps

setAvailability

public void setAvailability(JDFDeviceCap.EnumAvailability value)

Sets attribute Availability

Specified by:

setAvailability in interface ICapabilityElement

Parameters:

value - the value to set the attribute to

getAvailability

public JDFDeviceCap.EnumAvailability getAvailability()

Gets typesafe enumerated attribute Availability

Specified by:

getAvailability in interface ICapabilityElement

Returns:

EnumAvailability: the enumeration value of the attribute

getParentDevCap

public JDFDevCap getParentDevCap()

get the parent devCap of this

Returns:

setDevNS

public void setDevNS(String value)

Sets attribute DevNS

Parameters:

value - the value to set the attribute to

getDevNS

public String getDevNS()

Gets URI attribute DevNS

Returns:

String: the attribute value

setHasDefault

public void setHasDefault(boolean value)

Sets attribute HasDefault, default=true

Parameters:

value - the value to set the attribute to

getHasDefault

public boolean getHasDefault()

Gets boolean attribute HasDefault

Returns:

boolean: the attribute value

setMaxOccurs

public void setMaxOccurs(int value)

Sets attribute MaxOccurs,

Parameters:

value - the value to set the attribute to

getMaxOccurs

public int getMaxOccurs()

Gets integer attribute MaxOccurs

Returns:

int: the attribute value

setMinOccurs

public void setMinOccurs(int value)

Sets attribute MinOccurs, default=1

Parameters:

value - the value to set the attribute to

getMinOccurs

public int getMinOccurs()

Get integer attribute MinOccurs

Returns:

int: the attribute value

setName

public void setName(String value)

Sets String attribute Name
Since name is independent of the data type of the State element, the setter is defined here

Parameters:

value - the value to set the attribute to

getName

public String getName()

Gets String attribute Name
Since name is independent of the data type of the State element,the getter is defined here

Returns:

String: the attribute value

setRequired

public void setRequired(boolean value)

Sets attribute Required

Parameters:

value - the value to set the attribute to

getRequired

public boolean getRequired()

Gets boolean attribute Required

Returns:

boolean: the attribute value

setListType

public void setListType(JDFAutoBasicPreflightTest.EnumListType value)

Sets attribute ListType, default=SingleValue

Parameters:

value - the value to set the attribute to

getListType

public JDFAutoBasicPreflightTest.EnumListType getListType()

Gets typesafe enumerated attribute ListType

Returns:

EnumListType: the enumeration value of the attribute

setActionRefs

public void setActionRefs(VString value)

Sets attribute ActionRefs

Parameters:

value - vector of ActionRefs

getActionRefs

public VString getActionRefs()

Gets NMTOKENS attribute ActionRefs

Returns:

VString: the attribute value

setEditable

public void setEditable(boolean value)

Sets attribute Editable

Parameters:

value - the value to set the attribute to

getEditable

public boolean getEditable()

Gets boolean attribute Editable

Returns:

boolean: the attribute value

setMacroRefs

public void setMacroRefs(VString value)

Sets attribute MacroRefs

Parameters:

value - vector of MacroRefs

getMacroRefs

public VString getMacroRefs()

Get NMTOKENS attribute MacroRefs

Returns:

VString: the attribute value

setDependentMacroRef

public void setDependentMacroRef(String value)

Sets attribute DependentMacroRef

Parameters:

value - vector of DependentMacroRef

getDependentMacroRef

public String getDependentMacroRef()

Get string attribute DependentMacroRef

Returns:

String: the attribute value

setUserDisplay

public void setUserDisplay(JDFAbstractState.EnumUserDisplay value)

Sets attribute UserDisplay, default=Display

Parameters:

value - the value to set the attribute to

getUserDisplay

public JDFAbstractState.EnumUserDisplay getUserDisplay()

Gets typesafe enumerated attribute UserDisplay

Returns:

EnumUserDisplay: the enumeration value of the attribute

getCreateLoc

public JDFLoc getCreateLoc(int iSkip)

Gets the iSkip-th element Loc. If doesn't exist, it is created.

default: getCreateLoc(0)

Parameters:

iSkip - number of elements to skip

Returns:

JDFLoc: the matching element

getLoc

public JDFLoc getLoc(int iSkip)

Gets the iSkip-th element Loc

default: getCreateLoc(0)

Parameters:

iSkip - number of elements to skip

Returns:

JDFLoc: the matching element

appendLoc

public JDFLoc appendLoc()

Appends element Loc to the end of this

Returns:

JDFLoc: newly created Loc element

setAllowedLength

protected void setAllowedLength(JDFIntegerRange value)

set attribute AllowedLength

Parameters:

value - the value to set the attribute to

getAllowedLength

protected JDFIntegerRange getAllowedLength()

get attribute AllowedLength

Returns:

JDFIntegerRange: the attribute value

setPresentLength

protected void setPresentLength(JDFIntegerRange value)

getPresentLength

protected JDFIntegerRange getPresentLength()

fitsLength

protected final boolean fitsLength(String str,
                 JDFBaseDataTypes.EnumFitsValue length)

fitsLength - tests, if the defined String str matches AllowedLength or the PresentLength, specified for this State

Parameters:

str - string to test

length - switches between AllowedLength and PresentLength.

Returns:

boolean - true, if 'str' matches Length or if AllowedLength is not specified

getMatchingObjectInNode

public Object getMatchingObjectInNode(KElement element)

gets the matching Attribute value String or AbstractSpan object from the parent, depending on the type of the state

Parameters:

element - the parent in which to search

Returns:

Object: either a String or AbstractSpan

setDefaultsFromCaps

public boolean setDefaultsFromCaps(KElement element,
                          boolean bAll)

set the default values specified in this in element

Parameters:

element - the element to set the defaults on

bAll -

Returns:

true if successful

fitsListType

protected final boolean fitsListType(String value)

fitsListType - tests, if the defined value matches value of ListType attribute, specified for this State

Parameters:

value - value to test

Returns:

boolean - true, if 'value' matches specified ListType

getInvalidAttributesImpl

protected VString getInvalidAttributesImpl(JDFElement.EnumValidationLevel level,
                               boolean bIgnorePrivate,
                               int nMax)

getValueLocLoc

public JDFLoc getValueLocLoc(int iSkip,
                    int jSkip)

Gets the j-th element Loc of the i-th element Value

Parameters:

iSkip - number of Value elements to skip (iSkip=0 - first Value element)

jSkip - number of Loc subelements of i-th Value element to skip, (jSkip=0 - first Loc element)

Returns:

JDFLoc: the matching Loc element

getValueLoc

public final JDFValueLoc getValueLoc(int iSkip)

get iSkip'th element Loc

Parameters:

iSkip - number of Value elements to skip (iSkip=0 - get first element)

Returns:

JDFValueLoc: the element

appendValueLocLoc

public JDFLoc appendValueLocLoc(int iSkip)

appends element Loc to the end of the i-th subelement Value

Parameters:

iSkip - number of Value elements to skip (iSkip=0 - first Value element)

Returns:

JDFLoc: newly created Loc element

appendValueLoc

public final JDFValueLoc appendValueLoc()

Appends element ValueLoc

Returns:

JDFLoc: newly created ValueLoc element

fitsRegExp

protected final boolean fitsRegExp(String str,
                 JDFBaseDataTypes.EnumFitsValue regexp)

fitsRegExp - checks whether str matches the AllowedRegExp/PresentRegExp specified for this State

Parameters:

str - string to test

regexp - switches between AllowedRegExp and PresentRegExp.

Returns:

boolean - true, if str matches the RegExp or if AllowedRegExp is not specified

getPresentRegExp

protected String getPresentRegExp()

Returns:

getAllowedRegExp

protected String getAllowedRegExp()

Returns:

getModuleAvailability

public JDFDeviceCap.EnumAvailability getModuleAvailability()

get the availability of this devcaps based on the list of installed modules in ModuleRefs and ModulePool

Returns:

getModulePool

public JDFModulePool getModulePool()

Description copied from interface: ICapabilityElement

get the ModulePool that contains ModuleCap elements referenced by this

Specified by:

getModulePool in interface ICapabilityElement

Returns:

See Also:

ICapabilityElement.getModulePool()

getCreateModulePool

public JDFModulePool getCreateModulePool()

Description copied from interface: ICapabilityElement

get the ModulePool that contains ModuleCap elements referenced by this create one, if it does not exist

Specified by:

getCreateModulePool in interface ICapabilityElement

Returns:

See Also:

ICapabilityElement.getCreateModulePool()

getModuleRefs

public VString getModuleRefs()

(21) get VString attribute ModuleRefs

Specified by:

getModuleRefs in interface ICapabilityElement

Returns:

VString the value of the attribute

appendModuleRef

public JDFModuleCap appendModuleRef(String id)

Description copied from interface: ICapabilityElement

append moduleRef to moduleRefs, if it does not exist, set the availability to module and ensure that the appropriate modulecap exists

Specified by:

appendModuleRef in interface ICapabilityElement

Parameters:

id -

Returns:

See Also:

ICapabilityElement.appendModuleRef(java.lang.String)

init

public boolean init()

Description copied from class: KElement

Method init. Superclass of all inits

Overrides:

init in class KElement

Returns:

See Also:

KElement.init()

getIDPrefix

protected String getIDPrefix()

Description copied from class: KElement

getIDPrefix

Overrides:

getIDPrefix in class KElement

Returns:

the default ID prefix of non-overwritten JDF elements

getEvaluationType

public abstract JDFTerm.EnumTerm getEvaluationType()

Description copied from interface: ICapabilityElement

get the type of evaluation that is appropriate for this ICapabilityElement

Specified by:

getEvaluationType in interface ICapabilityElement

Returns:

See Also:

ICapabilityElement.getEvaluationType()