Package org.cip4.jdflib.auto

Class JDFAutoScanParams

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.JDFAutoScanParams
All Implemented Interfaces:
Serializable, Cloneable, IStreamWriter, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo
Direct Known Subclasses:
JDFScanParams
public abstract class JDFAutoScanParams extends JDFResource
class JDFAutoScanParams : public JDFResource
See Also:

  • Constructor Details

    • JDFAutoScanParams

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

    • JDFAutoScanParams

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

    • JDFAutoScanParams

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

  • Method Details

    • getTheAttributeInfo

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

    • getTheElementInfo

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

    • init

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

    • getValidClass

      public JDFResource.EnumResourceClass getValidClass()
      Description copied from class: JDFResource
      get the fixed class for this resource,
      Overrides:
      getValidClass in class JDFResource
      Returns:
      the resource Class

    • setBitDepth

      public void setBitDepth(int value)
      (36) set attribute BitDepth
      Parameters:
      value - the value to set the attribute to

    • getBitDepth

      public int getBitDepth()
      (15) get int attribute BitDepth
      Returns:
      int the value of the attribute

    • setMagnification

      public void setMagnification(JDFXYPair value)
      (36) set attribute Magnification
      Parameters:
      value - the value to set the attribute to

    • getMagnification

      public JDFXYPair getMagnification()
      (20) get JDFXYPair attribute Magnification
      Returns:
      JDFXYPair the value of the attribute, null if a the attribute value is not a valid to create a JDFXYPair

    • setOutputColorSpace

      public void setOutputColorSpace(JDFAutoScanParams.EOutputColorSpace enumVar)
      (5) set attribute OutputColorSpace
      Parameters:
      enumVar - the enumVar to set the attribute to

    • getEOutputColorSpace

      public JDFAutoScanParams.EOutputColorSpace getEOutputColorSpace()
      (9) get attribute OutputColorSpace
      Returns:
      the value of the attribute

    • setOutputColorSpace

      @Deprecated public void setOutputColorSpace(JDFAutoScanParams.EnumOutputColorSpace enumVar)
      Deprecated.
      use SetOutputColorSpace(EOutputColorSpace) based on java.lang.enum instead
      (5) set attribute OutputColorSpace
      Parameters:
      enumVar - the enumVar to set the attribute to

    • getOutputColorSpace

      @Deprecated public JDFAutoScanParams.EnumOutputColorSpace getOutputColorSpace()
      Deprecated.
      use EOutputColorSpace GetEOutputColorSpace() based on java.lang.enum instead
      (9) get attribute OutputColorSpace
      Returns:
      the value of the attribute

    • setCompressionFilter

      public void setCompressionFilter(JDFAutoScanParams.ECompressionFilter enumVar)
      (5) set attribute CompressionFilter
      Parameters:
      enumVar - the enumVar to set the attribute to

    • getECompressionFilter

      public JDFAutoScanParams.ECompressionFilter getECompressionFilter()
      (9) get attribute CompressionFilter
      Returns:
      the value of the attribute

    • setCompressionFilter

      @Deprecated public void setCompressionFilter(JDFAutoScanParams.EnumCompressionFilter enumVar)
      Deprecated.
      use SetCompressionFilter(ECompressionFilter) based on java.lang.enum instead
      (5) set attribute CompressionFilter
      Parameters:
      enumVar - the enumVar to set the attribute to

    • getCompressionFilter

      @Deprecated public JDFAutoScanParams.EnumCompressionFilter getCompressionFilter()
      Deprecated.
      use ECompressionFilter GetECompressionFilter() based on java.lang.enum instead
      (9) get attribute CompressionFilter
      Returns:
      the value of the attribute

    • setDCTQuality

      public void setDCTQuality(double value)
      (36) set attribute DCTQuality
      Parameters:
      value - the value to set the attribute to

    • getDCTQuality

      public double getDCTQuality()
      (17) get double attribute DCTQuality
      Returns:
      double the value of the attribute

    • setInputBox

      public void setInputBox(JDFRectangle value)
      (36) set attribute InputBox
      Parameters:
      value - the value to set the attribute to

    • getInputBox

      public JDFRectangle getInputBox()
      (20) get JDFRectangle attribute InputBox
      Returns:
      JDFRectangle the value of the attribute, null if a the attribute value is not a valid to create a JDFRectangle

    • setMountID

      public void setMountID(String value)
      (36) set attribute MountID
      Parameters:
      value - the value to set the attribute to

    • getMountID

      public String getMountID()
      (23) get String attribute MountID
      Returns:
      the value of the attribute

    • setMounting

      public void setMounting(JDFAutoScanParams.EMounting enumVar)
      (5) set attribute Mounting
      Parameters:
      enumVar - the enumVar to set the attribute to

    • getEMounting

      public JDFAutoScanParams.EMounting getEMounting()
      (9) get attribute Mounting
      Returns:
      the value of the attribute

    • setMounting

      @Deprecated public void setMounting(JDFAutoScanParams.EnumMounting enumVar)
      Deprecated.
      use SetMounting(EMounting) based on java.lang.enum instead
      (5) set attribute Mounting
      Parameters:
      enumVar - the enumVar to set the attribute to

    • getMounting

      @Deprecated public JDFAutoScanParams.EnumMounting getMounting()
      Deprecated.
      use EMounting GetEMounting() based on java.lang.enum instead
      (9) get attribute Mounting
      Returns:
      the value of the attribute

    • setOutputResolution

      public void setOutputResolution(JDFXYPair value)
      (36) set attribute OutputResolution
      Parameters:
      value - the value to set the attribute to

    • getOutputResolution

      public JDFXYPair getOutputResolution()
      (20) get JDFXYPair attribute OutputResolution
      Returns:
      JDFXYPair the value of the attribute, null if a the attribute value is not a valid to create a JDFXYPair

    • setOutputSize

      public void setOutputSize(JDFXYPair value)
      (36) set attribute OutputSize
      Parameters:
      value - the value to set the attribute to

    • getOutputSize

      public JDFXYPair getOutputSize()
      (20) get JDFXYPair attribute OutputSize
      Returns:
      JDFXYPair the value of the attribute, null if a the attribute value is not a valid to create a JDFXYPair

    • setSplitDocuments

      public void setSplitDocuments(int value)
      (36) set attribute SplitDocuments
      Parameters:
      value - the value to set the attribute to

    • getSplitDocuments

      public int getSplitDocuments()
      (15) get int attribute SplitDocuments
      Returns:
      int the value of the attribute

    • getFileSpec

      public JDFFileSpec getFileSpec()
      (24) const get element FileSpec
      Returns:
      JDFFileSpec the element

    • getCreateFileSpec

      public JDFFileSpec getCreateFileSpec()
      (25) getCreateFileSpec
      Returns:
      JDFFileSpec the element

    • getCreateFileSpec

      public JDFFileSpec getCreateFileSpec(int iSkip)
      (26) getCreateFileSpec
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFFileSpec the element

    • getFileSpec

      public JDFFileSpec getFileSpec(int iSkip)
      (27) const get element FileSpec
      Parameters:
      iSkip - number of elements to skip
      Returns:
      JDFFileSpec the element default is getFileSpec(0)

    • getAllFileSpec

      public Collection<JDFFileSpec> getAllFileSpec()
      Get all FileSpec from the current element
      Returns:
      Collection, null if none are available

    • appendFileSpec

      public JDFFileSpec appendFileSpec()
      (30) append element FileSpec
      Returns:
      JDFFileSpec the element

    • refFileSpec

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