BaseGoldenTicket (JDFLibJ 2.1.4a.75 API)

java.lang.Object
- org.cip4.jdflib.goldenticket.BaseGoldenTicket

Direct Known Subclasses:

JMFGoldenTicket, MISGoldenTicket
```
public class BaseGoldenTicket
extends Object
```
Author:

rainer prosi class that generates golden tickets based on ICS levels etc basegolden ticket should generally be the last in the cascade domain - mis - jmf - base To generate a new golden ticket, follow these steps 1.) construct the appropriate domain subclass, e.g. MISCPGoldenTicket for mis to conventional print 2.) call .assign(null) (or your favorite hand-coded jdf node) 3.) retrieve the updated copy with .getNode()

Field Summary

Fields
Modifier and Type	Field and Description
`protected VString`	`amountLinks`
`protected int`	`baseICSLevel`
`boolean`	`bExpandGrayBox`
`boolean`	`bPartitionedPlateMedia`
`VString`	`cols` the list of separation names
`VString`	`colsActual`
`static String`	`deviceURL`
`String`	`devID`
`boolean`	`getNIFromParent`
`int`	`good` good for plan and execute
`protected int`	`icsLevel`
`String`	`m_pdfFile`
`static String`	`misURL`
`int[]`	`nCols`
`JDFMedia`	`paperMedia`
`String`	`paperProductID`
`protected VString`	`partIDKeys`
`int`	`partsAtOnce`
`int`	`partsForAvailable`
`String`	`plateReduction` list of partition keys NOT to partition by
`String`	`returnURL` if set, the returnURL will be initialized
`protected JDFNode`	`theExpandedNode`
`protected JDFNode`	`theNode`
`protected JDFNode`	`theParentNode`
`JDFNode`	`theParentProduct`
`protected JDFNode`	`thePreviousNode`
`protected StatusCounter`	`theStatusCounter`
`protected JDFElement.EnumVersion`	`theVersion`
`VJDFAttributeMap`	`vParts`
`int`	`waste` pwaste for plan and execute
`JDFAutoConventionalPrintingParams.EnumWorkStyle`	`workStyle`

Constructor Summary

Constructors
Constructor and Description
`BaseGoldenTicket(BaseGoldenTicket parent)` create a BaseGoldenTicket
`BaseGoldenTicket(int pIcsLevel, JDFElement.EnumVersion jdfVersion)` create a BaseGoldenTicket

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAmountLink(String link)` add the type of amount link for resource audits etc
`protected JDFNode`	`addJDFNode(JDFNode node, JDFNode.EnumType t)`
`void`	`addKid(BaseGoldenTicket bt)` add a kid to be makeready and executed
`void`	`addSheet(String sheetName)` add a signature sheet combination
`void`	`assign(JDFNode node)` assign a node to this golden ticket instance
`static VJDFAttributeMap`	`createSheetMap(int n)` TODO Please insert comment!
`void`	`execute(VJDFAttributeMap vMap, boolean bOutAvail, boolean bFirst)` simulate execution of this node the internal node will be modified to reflect the excution
`void`	`executeAll(VJDFAttributeMap parts)` execute for all kids
`protected void`	`finalize()` do the last steps prior to processrun
`static String`	`getDeviceURL()`
`VString`	`getICSVersions()`
`static String`	`getMisURL()`
`int`	`getNCols()`
`JDFNode`	`getNode()` gets the current state of the node
`protected VElement`	`getNodeLinks()`
`protected VJDFAttributeMap`	`getReducedMap(VString reduceKeys)` get a reduced partionmap missing the keys in reduceKeys
`StatusCounter`	`getStatusCounter()`
`void`	`init()` initializes this node to a given ICS version
`void`	`initAuditPool(JDFNode node)`
`protected void`	`initColorantControl()`
`protected JDFDevice`	`initDevice(JDFNode previousNode)`
`protected JDFRunList`	`initDocumentRunList()`
`protected void`	`initJDF()`
`protected JDFNodeInfo`	`initNodeInfo()`
`protected JDFComponent`	`initOutputComponent()`
`protected JDFMedia`	`initPaperMedia()`
`protected JDFMedia`	`initPlateMedia()`
`protected void`	`initPlateXM(JDFResourceLink.EnumUsage usage)`
`void`	`makeReady()` simulate makeReady of this node the internal node will be modified to reflect the makeready all required resources should be available
`void`	`makeReadyAll()` makeready for all kids
`protected void`	`runphases(int pgood, int pwaste, boolean bOutAvail, boolean bFirst)`
`protected void`	`runSinglePhase(int pgood, int pwaste, boolean bOutAvail, boolean bFirst)`
`void`	`schedule(VJDFAttributeMap partsToSchedule, int starthours, int durationhours)` schedule this node the nodeinfo will be modified
`void`	`setActivePart(VJDFAttributeMap vp, boolean bFirst)`
`static void`	`setDeviceURL(String pdeviceURL)`
`static void`	`setMisURL(String _misURL)`
`void`	`setParent(boolean bProduct)`
`void`	`setPreviousNode(JDFNode node)` assign a previous node to this golden ticket instance, e.g.
`protected void`	`setVersion()`
`String`	`toString()`
`void`	`write2File(String file, int indent)`

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

amountLinks
```
protected VString amountLinks
```

theNode
```
protected JDFNode theNode
```

theExpandedNode
```
protected JDFNode theExpandedNode
```

thePreviousNode
```
protected JDFNode thePreviousNode
```

theParentNode
```
protected JDFNode theParentNode
```

theParentProduct
```
public JDFNode theParentProduct
```

theVersion

protected JDFElement.EnumVersion theVersion

baseICSLevel
```
protected int baseICSLevel
```

icsLevel
```
protected int icsLevel
```

theStatusCounter

protected StatusCounter theStatusCounter

misURL
```
public static String misURL
```

deviceURL
```
public static String deviceURL
```

vParts
```
public VJDFAttributeMap vParts
```

cols
```
public VString cols
```
the list of separation names

colsActual
```
public VString colsActual
```

plateReduction
```
public String plateReduction
```
list of partition keys NOT to partition by

nCols
```
public int[] nCols
```

paperProductID
```
public String paperProductID
```

partIDKeys
```
protected VString partIDKeys
```

workStyle

public JDFAutoConventionalPrintingParams.EnumWorkStyle workStyle

devID
```
public String devID
```

good
```
public int good
```
good for plan and execute

waste
```
public int waste
```
pwaste for plan and execute

partsAtOnce
```
public int partsAtOnce
```

partsForAvailable
```
public int partsForAvailable
```

bExpandGrayBox
```
public boolean bExpandGrayBox
```

bPartitionedPlateMedia
```
public boolean bPartitionedPlateMedia
```

paperMedia
```
public JDFMedia paperMedia
```

returnURL
```
public String returnURL
```
if set, the returnURL will be initialized

getNIFromParent
```
public boolean getNIFromParent
```

m_pdfFile
```
public String m_pdfFile
```

Constructor Detail
- BaseGoldenTicket
```
public BaseGoldenTicket(int pIcsLevel,
                JDFElement.EnumVersion jdfVersion)
```
  create a BaseGoldenTicket
  
  Parameters:
  pIcsLevel - the level to init to (1,2 or 3)
  jdfVersion - the version to generate a golden ticket for
- BaseGoldenTicket
```
public BaseGoldenTicket(BaseGoldenTicket parent)
```
  create a BaseGoldenTicket
  
  Parameters:
  parent -

Method Detail
- createSheetMap
```
public static VJDFAttributeMap createSheetMap(int n)
```
  TODO Please insert comment!
  
  Parameters:
  n -
  
  Returns:
- initNodeInfo
```
protected JDFNodeInfo initNodeInfo()
```
  Returns:
- assign
```
public void assign(JDFNode node)
```
  assign a node to this golden ticket instance
  
  Parameters:
  node - the node to assign, if null a new conforming node is generated from scratch
- setPreviousNode
```
public void setPreviousNode(JDFNode node)
```
  assign a previous node to this golden ticket instance, e.g. an imagesetting node
  
  Parameters:
  node - the node to assign, if null a new conforming node is generated from scratch
- addKid
```
public void addKid(BaseGoldenTicket bt)
```
  add a kid to be makeready and executed
  
  Parameters:
  bt - the golden ticket to assign, if null a new conforming node is generated from scratch
- makeReadyAll
```
public void makeReadyAll()
```
  makeready for all kids
- makeReady
```
public void makeReady()
```
  simulate makeReady of this node the internal node will be modified to reflect the makeready all required resources should be available
- setActivePart
```
public void setActivePart(VJDFAttributeMap vp,
                 boolean bFirst)
```
  Parameters:
  vp -
  bFirst -
- executeAll
```
public void executeAll(VJDFAttributeMap parts)
```
  execute for all kids
  
  Parameters:
  parts -
- execute
```
public void execute(VJDFAttributeMap vMap,
           boolean bOutAvail,
           boolean bFirst)
```
  simulate execution of this node the internal node will be modified to reflect the excution
  
  Parameters:
  vMap -
  bOutAvail -
  bFirst -
- runphases
```
protected void runphases(int pgood,
             int pwaste,
             boolean bOutAvail,
             boolean bFirst)
```
- schedule
```
public void schedule(VJDFAttributeMap partsToSchedule,
            int starthours,
            int durationhours)
```
  schedule this node the nodeinfo will be modified
  
  Parameters:
  partsToSchedule -
  starthours -
  durationhours -
- runSinglePhase
```
protected final void runSinglePhase(int pgood,
                  int pwaste,
                  boolean bOutAvail,
                  boolean bFirst)
```
  Parameters:
  pgood -
  pwaste -
  bOutAvail -
  bFirst -
- finalize
```
protected void finalize()
```
  do the last steps prior to processrun
  
  Overrides:
  
  finalize in class Object
- setVersion
```
protected void setVersion()
```
- setParent
```
public void setParent(boolean bProduct)
```
  Parameters:
  bProduct -
- init
```
public void init()
```
  initializes this node to a given ICS version
- initDevice
```
protected JDFDevice initDevice(JDFNode previousNode)
```
  Parameters:
  previousNode -
  
  Returns:
- initAuditPool
```
public void initAuditPool(JDFNode node)
```
  Parameters:
  node -
- addJDFNode
```
protected JDFNode addJDFNode(JDFNode node,
                 JDFNode.EnumType t)
```
  Parameters:
  node -
  t -
  
  Returns:
- initJDF
```
protected void initJDF()
```
- getICSVersions
```
public VString getICSVersions()
```
  Returns:
- getNodeLinks
```
protected VElement getNodeLinks()
```
  Returns:
- getNode
```
public JDFNode getNode()
```
  gets the current state of the node
  
  Returns:
  the theNode
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
  
  See Also:
  Object.toString()
- write2File
```
public void write2File(String file,
              int indent)
```
  Parameters:
  file -
  indent -
- getStatusCounter
```
public StatusCounter getStatusCounter()
```
  Returns:
- getDeviceURL
```
public static String getDeviceURL()
```
  Returns:
- setDeviceURL
```
public static void setDeviceURL(String pdeviceURL)
```
  Parameters:
  pdeviceURL -
- getMisURL
```
public static String getMisURL()
```
  Returns:
- setMisURL
```
public static void setMisURL(String _misURL)
```
  Parameters:
  _misURL -
- addSheet
```
public void addSheet(String sheetName)
```
  add a signature sheet combination
  
  Parameters:
  sheetName -
- addAmountLink
```
public void addAmountLink(String link)
```
  add the type of amount link for resource audits etc
  
  Parameters:
  link -
- initColorantControl
```
protected void initColorantControl()
```
- initPaperMedia
```
protected JDFMedia initPaperMedia()
```
  Returns:
- getReducedMap
```
protected VJDFAttributeMap getReducedMap(VString reduceKeys)
```
  get a reduced partionmap missing the keys in reduceKeys
  
  Parameters:
  reduceKeys -
  
  Returns:
  the reduced map
- initPlateXM
```
protected void initPlateXM(JDFResourceLink.EnumUsage usage)
```
  Parameters:
  usage -
- initPlateMedia
```
protected JDFMedia initPlateMedia()
```
  Returns:
  the Media
- getNCols
```
public int getNCols()
```
  Returns:
  the number of colors
- initDocumentRunList
```
protected JDFRunList initDocumentRunList()
```
  Returns:
- initOutputComponent
```
protected JDFComponent initOutputComponent()
```
  Returns:

Class BaseGoldenTicket

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

amountLinks

theNode

theExpandedNode

thePreviousNode

theParentNode

theParentProduct

theVersion

baseICSLevel

icsLevel

theStatusCounter

misURL

deviceURL

vParts

cols

colsActual

plateReduction

nCols

paperProductID

partIDKeys

workStyle

devID

good

waste

partsAtOnce

partsForAvailable

bExpandGrayBox

bPartitionedPlateMedia

paperMedia

returnURL

getNIFromParent

m_pdfFile

Constructor Detail

BaseGoldenTicket

BaseGoldenTicket

Method Detail

createSheetMap

initNodeInfo

assign

setPreviousNode

addKid

makeReadyAll

makeReady

setActivePart

executeAll

execute

runphases

schedule

runSinglePhase

finalize

setVersion

setParent

init

initDevice

initAuditPool

addJDFNode

initJDF

getICSVersions

getNodeLinks

getNode

toString

write2File

getStatusCounter

getDeviceURL

setDeviceURL

getMisURL

setMisURL

addSheet

addAmountLink

initColorantControl

initPaperMedia

getReducedMap

initPlateXM

initPlateMedia

getNCols