Package org.cip4.jdflib.resource

Class JDFSignature

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.JDFResource
org.cip4.jdflib.auto.JDFAutoLayout
org.cip4.jdflib.resource.JDFSignature
All Implemented Interfaces:
Serializable, Cloneable, IStreamWriter, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo
Direct Known Subclasses:
JDFSheet
public class JDFSignature extends JDFAutoLayout
class that maps both patitioned and non-partitoned layouts
See Also:

  • Constructor Details

    • JDFSignature

      public JDFSignature(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String qualifiedName)
      Constructor for JDFSignature
      Parameters:
      myOwnerDocument -
      qualifiedName -

    • JDFSignature

      public JDFSignature(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName)
      Constructor for JDFSignature
      Parameters:
      myOwnerDocument -
      myNamespaceURI -
      qualifiedName -

    • JDFSignature

      public JDFSignature(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName, String myLocalName)
      Constructor for JDFSignature
      Parameters:
      myOwnerDocument -
      myNamespaceURI -
      qualifiedName -
      myLocalName -

  • Method Details

    • getTheElementInfo

      protected ElementInfo getTheElementInfo()
      Overrides:
      getTheElementInfo in class JDFAutoLayout
      Returns:
      the elementinfo

    • getTheAttributeInfo

      protected AttributeInfo getTheAttributeInfo()
      Overrides:
      getTheAttributeInfo in class JDFAutoLayout
      Returns:

    • toString

      public String toString()
      toString()
      Overrides:
      toString in class KElement
      Returns:
      String
      See Also:

    • init

      public boolean init()
      Description copied from class: JDFResource
      default initialization
      Overrides:
      init in class JDFAutoLayout
      Returns:
      true if ok
      See Also:

    • getCreateSheet

      public JDFSheet getCreateSheet(int iSkip)
      gets or appends a JDFSheet in both old and new Layouts
    • if old: a Sheet element
    • if new: a SheetName partition leaf
      • Parameters:
      iSkip - the number of Sheets to skip
      Returns:
      JDFSheet

    • getSheet

      public JDFSheet getSheet(int iSkip)
      gets a Sheet in both old and new Layouts
    • if old: a Sheet element
    • if new: a SheetName partition leaf
      • Parameters:
      iSkip - the number of Sheets to skip
      Returns:
      JDFSheet

    • getSheet

      public JDFSheet getSheet(String sheetName)
      gets a signature in both old and new Layouts if old: a element if new: a SignatureName partition leaf
      Parameters:
      sheetName - the SheetName partition key value(new) or Sheet/@Name(old)
      Returns:
      the signature

    • getCreateSheet

      public JDFSheet getCreateSheet(String sheetName) throws JDFException
      gets a signature in both old and new Layouts if old: a creates it if it does not exist element if new: a SignatureName partition leaf
      Parameters:
      sheetName - the SheetName partition key value(new) or Sheet/@Name(old)
      Returns:
      the signature
      Throws:
      JDFException

    • numSheets

      public int numSheets()
      counts the number of Sheets in both old and new Layouts
    • if old: a Sheet element
    • if new: a SheetName partition leaf
      • Returns:
      the number of Sheets

    • getSheetVector

      @Deprecated public VElement getSheetVector(JDFAttributeMap mAttrib, boolean bAnd)
      Deprecated.
      use getChildElementVector() instead
      (28) get vector of all direct child elements Sheet
      Parameters:
      mAttrib - the map of attributes to select
      bAnd - if true all attributes in the map are AND'ed, else they are OR'ed

    • getSheetVector

      public VElement getSheetVector()
      get the vector of sheets in this signature
      Returns:
      VElement the vector of signatures in this

    • appendSheet

      public JDFSheet appendSheet() throws JDFException
      appends a Sheet in both old and new Layouts
    • if old: a Sheet element
    • if new: a SheetName partition leaf
      • Throws:
      JDFException

    • refSheet

      public void refSheet(JDFSheet refTarget)
      (31) create inter-resource link to refTarget
      Parameters:
      refTarget - the element that is referenced

    • appendLayoutElement

      protected static JDFLayout appendLayoutElement(JDFResource layout, String elementName, String partitionKeyName) throws JDFException
      appends a signature in both old and new Layouts if old: a < Signature> element if new: a SignatureName partition leaf
      Parameters:
      layout -
      elementName -
      partitionKeyName -
      Returns:
      JDFLayout
      Throws:
      JDFException

    • numLayoutElements

      protected static int numLayoutElements(JDFResource layout, String elementName, String partitionKeyName)
      get the number of layout elements
      Parameters:
      layout -
      elementName -
      partitionKeyName -
      Returns:
      int: number of layout elements

    • getLayoutElement

      protected static JDFLayout getLayoutElement(JDFResource layout, String elementName, String partitionKeyName, int iSkip)
      get a specific layout element, in old style (pre 1.3) layouts, this must be a direct child wherea post 1.3 layouts allow for search of lower level elements (grandchildren etc.)
      Parameters:
      layout -
      elementName -
      partitionKeyName -
      iSkip - the index of the element, negative values count backwards from the end
      Returns:
      JDFLayout: the element

    • getLayoutElement

      protected static JDFLayout getLayoutElement(JDFResource layout, String elementName, String partitionKeyName, String objectName)
      get a specific layout element by name
      Parameters:
      layout -
      elementName -
      partitionKeyName -
      objectName -
      Returns:
      JDFLayout: the element

    • getCreateLayoutElement

      protected static JDFLayout getCreateLayoutElement(JDFResource layout, String elementName, String partitionKeyName, String objectName)
      get a specific layout element by name, creates it if it does not exist
      Parameters:
      layout -
      elementName -
      partitionKeyName -
      objectName -
      Returns:
      JDFLayout: the element
      Throws:
      JDFException - if the location of a newly created element is not well defined

    • getLayoutElementVector

      protected static VElement getLayoutElementVector(JDFResource layout, String elementName, String partitionKeyName)
      get a vector of specific layout elements
      Parameters:
      layout -
      elementName -
      partitionKeyName -
      Returns:
      VElement: the vector of elements

    • getLayoutLeaves

      public VElement getLayoutLeaves(boolean bAll)
      get the leaves of a layout, either pre 1.2 or post 1.3
      Returns:
      VElement the layout leaves, i.e. partition leaves(1.3+) or explicit surfaces(1.2-)

    • getSignatureName

      public String getSignatureName()
      if this is a new layout, return the partition key signaturename else return Signature/@Name of this or its appropriate parent
      Overrides:
      getSignatureName in class JDFResource
      Returns:
      the name of the signature

    • getMedia

      public JDFMedia getMedia(JDFAutoMedia.EnumMediaType mediaType)
      gets the corresponding media with a given mediatype
      Parameters:
      mediaType - the mediaType - must NOT be null
      Returns:
      the media, null if none is there or mediaType==null;

    • setSurfaceContentsBox

      public void setSurfaceContentsBox(JDFRectangle value, int precision)
      (36) set attribute SurfaceContentsBox
      Parameters:
      value - the value to set the attribute to
      precision -