Packagecom.adobe.livecycle.assembler.client
Classpublic class AssemblerOptionSpec
InheritanceAssemblerOptionSpec Inheritance Object

An AssemblerOptionSpec object is the container for the "environment" options for a DDX job. Current environment parameters include the job log level, the default style, and flags to indicate if the DDX job is a validation-only test or if it should fail if an error is encountered.


Public Methods
 MethodDefined By
  
AssemblerOptionSpec()
AssemblerOptionSpec
  
String getDefaultStyle()
Retrieves the default style.
AssemblerOptionSpec
  
int getFirstBatesNumber()
Returns the first numeric value for the first Bates number pattern if the start value is not specified.
AssemblerOptionSpec
  
String getLogLevel()
Retrieves the log level.
AssemblerOptionSpec
  
boolean isFailOnError()
Determines whether the DDX job should exit immediately when an Exception or other error occurs.
AssemblerOptionSpec
  
boolean isValidateOnly()
Determines whether the DDX job is a validation-only test.
AssemblerOptionSpec
  
void setDefaultStyle(String defaultStyle)
Sets a default style to use when none is specified in the DDX document.
AssemblerOptionSpec
  
void setFailOnError(boolean failOnError)
Sets whether the DDX job should exit immediately when an Exception or other error occurs.
AssemblerOptionSpec
  
void setFirstBatesNumber(int start)
Sets the first numeric value to use when the BatesNumber element does not contain a start attribute.
AssemblerOptionSpec
  
void setLogLevel(String logLevel)
Sets the log level.
AssemblerOptionSpec
  
void setValidateOnly(boolean validateOnly)
Sets whether the DDX job is a validation-only test, which means that Assembler should validate the DDX but not execute it.
AssemblerOptionSpec
Constructor Detail
AssemblerOptionSpec()
public AssemblerOptionSpec()

Method Detail
getDefaultStyle()
public String getDefaultStyle()

Retrieves the default style.

Returns
A java.lang.String containing the default style.
getFirstBatesNumber() 
public int getFirstBatesNumber()

Returns the first numeric value for the first Bates number pattern if the start value is not specified.

Returns
Returns the first Bates number. Returns -1 if not set.
getLogLevel() 
public String getLogLevel()

Retrieves the log level.

Returns
A String containing the log level.
isFailOnError() 
public boolean isFailOnError()

Determines whether the DDX job should exit immediately when an Exception or other error occurs.

Returns
true if the DDX job should exit immediately when an Exception or other error occurs, false otherwise.
isValidateOnly() 
public boolean isValidateOnly()

Determines whether the DDX job is a validation-only test.

Returns
true if the DDX job is a validation-only test, false otherwise.
setDefaultStyle() 
public void setDefaultStyle(String defaultStyle)

Sets a default style to use when none is specified in the DDX document.

Parameters

defaultStyle — The default style to set. This is a CSS2 style string in the format of "property: value; property: value". For instance, "font:<font-style> <font-weight> <font-size>/<line-height> <font-family-specifier>". Note that if the <font-family-specifier> contains spaces, it should be surrounded with single quotes. For example, 'Minion Pro'. If no default is ever specified, a default of "font: normal normal 12pt 'Minion Pro'" is used.

setFailOnError() 
public void setFailOnError(boolean failOnError)

Sets whether the DDX job should exit immediately when an Exception or other error occurs.

To see this method used in a code example, see the Programmatically Assembling PDF Documents quick start in the SDK Help.

Parameters

failOnError — A value of true means that the job will terminate upon an error or exception condition and throw the corresponding Throwable exception. A value of false means that the job will terminate the current DDX result block, store the Throwable exception in the output map, and attempt to execute any remaining result blocks. The default is true, meaning that the first error will terminate the DDX job immediately.

setFirstBatesNumber() 
public void setFirstBatesNumber(int start)

Sets the first numeric value to use when the BatesNumber element does not contain a start attribute.

Parameters

start — The first numeric value for the first Bates pattern.

setLogLevel() 
public void setLogLevel(String logLevel)

Sets the log level. The log level can be set to one of the following values that have integer equivalents:

If the log level is not set, then it defaults to "INFO". For investigation of problems, it can be set to "FINE", "FINER" or "FINEST", but performance will be negatively affected in this mode.

Parameters

logLevel — The log level to be set. This is the string representation of a java.util.logging.Level value.

setValidateOnly() 
public void setValidateOnly(boolean validateOnly)

Sets whether the DDX job is a validation-only test, which means that Assembler should validate the DDX but not execute it.

Parameters

validateOnly — A value of true halts processing of the DDX after the DDX has been parsed and verified to be in compliance with the schema and application validation rules. In this case the result map will be null, and the input map is allowed to be empty or null since the input data streams are not evaluated until actually used during job execution. The default is false, meaning that normal processing will be performed.




© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Wed Oct 1 2008, 10:46 PM -04:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/com/adobe/livecycle/assembler/client/AssemblerOptionSpec.html