org.cip4.jdflib.resource.process
Class JDFComChannel

java.lang.Object
  extended by org.apache.xerces.dom.NodeImpl
      extended by org.apache.xerces.dom.ChildNode
          extended by org.apache.xerces.dom.ParentNode
              extended by org.apache.xerces.dom.ElementImpl
                  extended by org.apache.xerces.dom.ElementNSImpl
                      extended by org.cip4.jdflib.core.KElement
                          extended by org.cip4.jdflib.core.JDFElement
                              extended by org.cip4.jdflib.resource.JDFResource
                                  extended by org.cip4.jdflib.auto.JDFAutoComChannel
                                      extended by org.cip4.jdflib.resource.process.JDFComChannel
All Implemented Interfaces:
Serializable, Cloneable, Element, EventTarget, Node, NodeList, TypeInfo

public class JDFComChannel
extends JDFAutoComChannel

Author:
Dr. Rainer Prosi, Heidelberger Druckmaschinen AG 13.02.2009
See Also:
Serialized Form

Nested Class Summary
static class JDFComChannel.EnumChannelTypeDetails
          some additionally specified details from the spec
 
Nested classes/interfaces inherited from class org.cip4.jdflib.auto.JDFAutoComChannel
JDFAutoComChannel.EnumChannelType
 
Nested classes/interfaces inherited from class org.cip4.jdflib.resource.JDFResource
JDFResource.EnumAmountMerge, JDFResource.EnumLotControl, JDFResource.EnumPartIDKey, JDFResource.EnumPartUsage, JDFResource.EnumResourceClass, JDFResource.EnumResStatus, JDFResource.EnumSpawnStatus, JDFResource.PartitionGetter
 
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
 
Field Summary
static String MAILTO
           
static String TEL
           
 
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.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
JDFComChannel(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String qualifiedName)
          Constructor for JDFComChannel
JDFComChannel(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName)
          Constructor for JDFComChannel
JDFComChannel(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName, String myLocalName)
          Constructor for JDFComChannel
 
Method Summary
 String getEMailAddress()
          get the email address of this, if this is an email address, else null any "mailto" is stripped
 String getPhoneNumber(boolean stripNonNumerical)
          get the phone number of this, if this is a valid phone address, else null any "tel:" or "fax:" is stripped
 void setEMailLocator(String eMail)
          sets locator to the string specified in eMail, checking valid email syntax "mailto:" is prepended, if it is not yet there
 void setPhoneNumber(String phone)
          set the phone number of this, if this is a valid phone url, "tel:" or "fax:" is prepended, if it is not yet there
 void setPhoneNumber(String phone, String replaceForBlank, JDFAutoComChannel.EnumChannelType channelType)
          set the phone number of this, if this is a valid phone url, "tel:" or "fax:" is prepended, if it is not yet there
 String toString()
          toString
 
Methods inherited from class org.cip4.jdflib.auto.JDFAutoComChannel
getChannelType, getChannelTypeDetails, getChannelUsage, getLocator, getTheAttributeInfo, getValidClass, init, setChannelType, setChannelTypeDetails, setChannelUsage, setLocator
 
Methods inherited from class org.cip4.jdflib.resource.JDFResource
addPartIDKey, addPartition, addPartition, addPartitions, addPipePartIDKey, appendContact, appendIdentical, appendIdentificationField, appendLocationElement, appendQualityControlResult, appendSourceResource, appendSpawnIDs, appendUpdate, buildXPath, cleanResourceAttributes, clonePartitions, collapse, collapse, consistentPartIDKeys, consistentPartIDKeys, consistentPipePartIDKeys, containsData, createPartitions, createSourceResource, deleteUnLinked, expand, getAgentName, getAgentVersion, getAlternateBrand, getAmount, getAmountProduced, getAmountRequired, getAttribute, getAttributeMap, getAttributePart, getAttributePartVector, getAttributeVector_JDFResource, getAttributeVector, getAuthor, getAutoAgent, getBatchID, getBinderySignatureName, getBlockName, getBrand, getBundleItemIndex, getCatalogDetails, getCatalogID, getCellIndex, getChildElementVector, getCondition, getContact, getCreateContact, getCreateElement_JDFResource, getCreateIdentical, getCreateIdentificationField, getCreateLocationElement, getCreatePartition, getCreatePartition, getCreateQualityControlResult, getCreator, getDeepPart, getDeepPart, getDeepPartVector, getDeliveryUnit, getDirectPartitionVector, getDocCopies, getDocIndex, getDocRunIndex, getDocSheetIndex, getElement, getFountainNumber, getGrossWeight, getIdentical, getIdenticalMap, getIdentificationField, getIDPrefix, getImplicitPartitions, getInvalidAttributes, getItemNames, getLayerIDs, getLeaves, getLinks, getLinks, getLinksAndRefs, getLinksAndRefs, getLinkString, getLocalPartitionKey, getLocation, getLocationElement, getLock, getLocked, getLotControl, getManufacturer, getNodesWithSpawnID, getNoOp, getOption, getPageNumber, getParentPartition, getPartIDKeys, getPartition, getPartition, getPartition, getPartitionLeafVector, getPartitionMap, getPartitionVector, getPartitionVector, getPartitionVector, getPartitionVector, getPartMap, getPartMap, getPartMapVector, getPartUsage, getPartValues, getPartVersion, getPipeID, getPipePartIDKeys, getPipePartIDKeysEnum, getPipeProtocol, getPipeURL, getPool, getPreflightRule, getPreviewType, getProductID, getQualityControlResult, getResourceClass, getResourcePool, getResourceRoot, getResourceRoot, getResourceWeight, getResStatus, getRibbonName, getRootPartAtts, getRun, getRunIndex, getRunPage, getRunSet, getRunTags, getSectionIndex, getSeparation, getSetDocIndex, getSetIndex, getSetRunIndex, getSetSheetIndex, getSheetIndex, getSheetName, getSide, getSignatureName, getSortAmount, getSorting, getSourceResource, getSpawnIDs, getSpawnStatus, getStationName, getStatus, getStatusFromLeaves, getTheElementInfo, getTileID, getUnit, getUpdate, getUpdate, getUpdateID, getUpdateName, getUpdateVector, getWebName, getWebProduct, getWebSetup, hasAttribute, hasPipePartIDKey, hasUpdate, isAvailable, isLeaf, isParameter, isPartitioningCompatible, isPartitioningCompatible, isPhysical, isQuantity, isResourceElement, isResourceRoot, isResourceRootRoot, isRootElement, isSpawnAllowed, isValid, lock, makeRootResource, matchesString, mergeCloneResource, mergePartition, mergeSpawnIDs, newModifiedID, numChildElements, numUpdates, reducePartitions, reduceParts, reducePartVector, removeAttribute, removeAttributeFromLeaves, removeFromSpawnIDs, removeInheritedAttributes, removeUpdate, removeUpdate, setAgentName, setAgentVersion, setAlternateBrand, setAmount, setAmountProduced, setAmountRequired, setAuthor, setAutoAgent, setAvailable, setBatchID, setBinderySignatureName, setBlockName, setBrand, setBundleItemIndex, setCatalogDetails, setCatalogID, setCellIndex, setCondition, setDeliveryUnit, setDocCopies, setDocIndex, setDocRunIndex, setDocSheetIndex, setFountainNumber, setGrossWeight, setIdentical, setIdentical, setItemNames, setLayerIDs, setLocation, setLocked, setLotControl, setManufacturer, setNoOp, setOption, setPageNumber, setPartIDKey, setPartIDKeys, setPartUsage, setPartVersion, setPipeID, setPipePartIDKey, setPipeProtocol, setPipeURL, setPreflightRule, setPreviewType, setProductID, setResourceClass, setResourceWeight, setResStatus, setRibbonName, setRun, setRunIndex, setRunPage, setRunSet, setRunTags, setSectionIndex, setSeparation, setSetDocIndex, setSetIndex, setSetRunIndex, setSetSheetIndex, setSheetIndex, setSheetName, setSide, setSignatureName, setSortAmount, setSorting, setSpawnIDs, setSpawnStatus, setStationName, setStatus, setStatus, setTileID, setUnit, setUnpartitiondImplicit, setUpdateID, setWebName, setWebProduct, setWebSetup, spawnPart, unpartition, unSpawnPart, updateAmounts, updateAttributeFromLeaves, validClass, validResourceClass
 
Methods inherited from class org.cip4.jdflib.core.JDFElement
appendAnchor, appendBestEffortExceptions, appendComment, appendElement, 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, getChildIds, getChildrenByTagName, getChildrenByTagName, getChildWithAttribute, getChildWithMatchingAttribute, getComment, getComment, getCommentURL, getCreateComment, getCreatePreview, getCreateRefElement, getDeepElementByID, getDefaultAttributeMap, getDefaultJDFVersion, getDeprecatedAttributes, getDeprecatedElements, getDescriptiveName, getElement_JDFElement, getElementIDPrefix, getElementNameVector, getEnumAttribute, getEnumerationsAttribute, getEnumerationsAttribute, getEnumforAttribute, getEnumNodeName, getEnumString, getFirstVersion, getGeneralID, getGeneralID, getGeneralID, getGeneralIDMap, getGeneralIDVectorMap, getHRef, getHRefs, getHRefs, getInsertElements, getInsertElementVector, getInvalidElements_JDFElement, getInvalidElements, getJDFRoot, getJMFRoot, getLastVersion, getLinkRoot, getMaxVersion, getMissingAttributes, getMissingAttributeVector, getMissingElements, getMissingElementVector, getMustHonorExceptions, getNamesVector, getOperatorInterventionExceptions, getOwnerDocument_JDFElement, getParentJDF, getParentJDF, getPartMapVector, getPrereleaseAttributes, getPrereleaseElements, getPreview, getRefElement, getRefElements, getRefString, getrRefs, 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, isDirty, isInJDFNameSpace, isInJDFNameSpaceStatic, isInJDFNameSpaceStatic, isJDFNode, isRefElement, isRefElementStatic, isResource, isResourceLink, isResourceLinkStatic, isResourceStatic, isResourceUpdate, isValid_JDFElement, jdfVersion, knownAttributes, knownElements, matchesPath, newID, numChildElements_JDFElement, 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
 
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, buildXPath, buildXPath, clone, copyAttribute, copyAttribute, copyElement, copyElements, copyXPathValue, createRoot, deleteNode, eraseEmptyAttributes, eraseEmptyNodes, fillHashSet, fitsName_KElement, fitsName, flush, generateDotID, getAttribute_KElement, getAttribute_KElement, getAttribute, getAttributeVector_KElement, getBoolAttribute, getCData, getChildAttributeList, getChildByTagName, getChildElementArray, getChildElementVector_KElement, getChildElementVector, getChildElementVector, getChildFromList, getChildFromList, getChildNode, getChildNodes_KElement, getChildNodeVector, getChildrenByClass, getChildrenByTagName_KElement, getChildrenFromList, getChildrenWithAttribute, 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, getXSIType, hasAttribute_KElement, 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, numSiblingElements, pushUp, removeAllText, removeAttribute_KElement, removeAttribute, removeAttributeNode, removeAttributeNS, removeAttributes, removeCData, removeChildNode, removeChildren, 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
 

Field Detail

MAILTO

public static final String MAILTO
See Also:
Constant Field Values

TEL

public static final String TEL
See Also:
Constant Field Values
Constructor Detail

JDFComChannel

public JDFComChannel(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                     String qualifiedName)
Constructor for JDFComChannel

Parameters:
myOwnerDocument -
qualifiedName -

JDFComChannel

public JDFComChannel(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                     String myNamespaceURI,
                     String qualifiedName)
Constructor for JDFComChannel

Parameters:
myOwnerDocument -
myNamespaceURI -
qualifiedName -

JDFComChannel

public JDFComChannel(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                     String myNamespaceURI,
                     String qualifiedName,
                     String myLocalName)
Constructor for JDFComChannel

Parameters:
myOwnerDocument -
myNamespaceURI -
qualifiedName -
myLocalName -
Method Detail

toString

public String toString()
toString

Overrides:
toString in class JDFAutoComChannel
Returns:
String
See Also:
Object.toString()

setEMailLocator

public void setEMailLocator(String eMail)
sets locator to the string specified in eMail, checking valid email syntax "mailto:" is prepended, if it is not yet there

Parameters:
eMail - the email address
Throws:
IllegalArgumentException - if eMail is not a valid emai as defined by JDFConstants.REGEXP_EMAIL

getEMailAddress

public String getEMailAddress()
get the email address of this, if this is an email address, else null any "mailto" is stripped

Returns:

getPhoneNumber

public String getPhoneNumber(boolean stripNonNumerical)
get the phone number of this, if this is a valid phone address, else null any "tel:" or "fax:" is stripped

Parameters:
stripNonNumerical - if true, remove any valid brackets, . / etc. so that a purely numerical code (except for an optional "+" for international) is returned
Returns:
the phone number

setPhoneNumber

public void setPhoneNumber(String phone)
set the phone number of this, if this is a valid phone url, "tel:" or "fax:" is prepended, if it is not yet there

Parameters:
phone - the phone number string
Throws:
IllegalArgumentException - if phone is not a valid phone number

setPhoneNumber

public void setPhoneNumber(String phone,
                           String replaceForBlank,
                           JDFAutoComChannel.EnumChannelType channelType)
set the phone number of this, if this is a valid phone url, "tel:" or "fax:" is prepended, if it is not yet there

Parameters:
phone - the phone number string
replaceForBlank - the replacement char for non-leading blanks , typically "." or null are a good idea
channelType - the channelType - must be either Fax or Phone
Throws:
IllegalArgumentException - if phone is not a valid phone number


Copyright © 2013. All Rights Reserved.