OptionsPDF

java.lang.Object
- com.moneythumb.convert.util.OptionsPDF

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class OptionsPDF
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
Class to specify options before calling PDFConvertServer

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`LOG_HTML`
`static int`	`LOG_HTML_BYTES`
`static int`	`LOG_NONE`
`static int`	`LOG_TXT`
`static int`	`PDF_BAL`
`static int`	`PDF_PL`
`static int`	`PDF_STATEMENT`
`static int`	`PDF_TAX`
`static int`	`TRANS_BYTES`
`static int`	`TRANS_CSV`
`static int`	`TRANS_JSON`
`static int`	`TRANS_POJO`

Constructor Summary

Constructors
Constructor and Description

OptionsPDF()
Default constructor

Constructors
Constructor and Description
`OptionsPDF()` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAccountnumber()` Get the current account number
`int`	`getAccountSeq()` Get the account sequence number
`java.lang.String`	`getBankID()` Get the current bankid
`boolean`	`getCombineLines()` Get the combine lines flag
`boolean`	`getCreateMap()` Return the value previously set for createMap
`int`	`getDocType()`
`boolean`	`getDoOCR()`
`java.lang.String`	`getLanguage()`
`java.io.File`	`getLogPath()` Get the current log path value
`int`	`getLogType()` return the log type
`int`	`getMonthSeq()` Get the month sequence number
`boolean`	`getNeedAlphas()`
`boolean`	`getNosepdates()` Get the option for whether dates must have a separator.
`int`	`getOutputType()` Return the value of the output type
`ConverterSetProgress`	`getProgressUpdate()` Get the progress update methods
`int`	`getStatementSeq()` Get the statement sequence number
`java.lang.String`	`getTrackingID()`
`void`	`setAccountNumber(java.lang.String accountnumber)` Set an account number to search for in the statement, used if the statement has multiple accounts
`void`	`setAccountSeq(int accountSequenceNnumber)` Set which account to process if there are multiple accounts in a single statement
`void`	`setAccountType(java.lang.String accountType)` Set the account type to be processed.
`void`	`setBankID(java.lang.String bankid)` Set the bankid to use when created OFX, QFX, QBO files
`void`	`setCallBack(ConverterCallback callback)` Set callback method for when OCR processing is complete
`void`	`setCombineLines(boolean combineLines)` Set option to combine description lines
`void`	`setCreateMap(boolean createMap)` Set option to create a .map file with page number and position of each transaction
`void`	`setDocType(int doctype)` Set the document type.
`boolean`	`setDoOCR(boolean doOCR)` Set the option for whether OCR should always be run, even if the PDF appears to be text based.
`boolean`	`setDoOCRnr(boolean doOCR)` Set option for always running OCR if the statement did not reconcile with text processing.
`void`	`setEndAccount(java.lang.String endAccount)`
`void`	`setFid(java.lang.String fid)` Set the Intuit FID, used by Quicken and QuickBooks in QBO and QFX files
`void`	`setFirstpage(int firstpage)` Set the first page in the PDF which should be processed.
`void`	`setFixedColumns(boolean fixedColumns)` Set option for how columns are defined in a csv file
`void`	`setLanguage(java.lang.String language)` Set the language of the statement to process
`void`	`setLastpage(int lastpage)` Set the last page in the PDF which should be processed.
`void`	`setLogPath(java.io.File logPath)` Set the path for the log file.
`void`	`setLogType(int logType)` Set the type of the log file
`void`	`setMonthSeq(int monthSequenceNnumber)` Set which statement to process if there are multiple (i.e.
`boolean`	`setNeedAlphas(boolean needalphas)`
`boolean`	`setNosepdates(boolean nosepdates)` Set the option for whether dates must have a separator.
`void`	`setOnecurrencycol(boolean onecurrencycol)`
`void`	`setOutputType(int outputType)` Set the method for returning transactions
`void`	`setPagewidth(java.lang.Float pagewidth)`
`void`	`setPassword(java.lang.String password)` Set the password required to read a password protected PDF
`void`	`setProgressupdate(BKProgressUpdate progressupdate)` Deprecated. - use setProgressUpdate instead
`void`	`setProgressUpdate(ConverterSetProgress progressupdate)` Set method to receive updates as the OCR processing proceeds
`void`	`setReadUSDates(boolean readUSDates)` Set the format for reading dates
`void`	`setRunOCRThread(boolean runOCRThread)` Flag for running OCR in a separate thread.
`void`	`setSpacing(java.lang.Float spacing)`
`void`	`setStartAccount(java.lang.String startAccount)`
`void`	`setStatementSeq(int statementSequenceNnumber)` Deprecated. - use setMonthSeq instead
`void`	`setTrackingID(java.lang.String trackingid)` Set an optional tracking ID on the conversion.
`void`	`setWriteUSDates(boolean writeUSDates)` Set the format for writing dates to csv files
`void`	`setYear(int year)`

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

- Field Detail
  - LOG_NONE
```
public static final int LOG_NONE
```
    See Also:
    
    Constant Field Values
  - LOG_TXT
```
public static final int LOG_TXT
```
    See Also:
    
    Constant Field Values
  - LOG_HTML
```
public static final int LOG_HTML
```
    See Also:
    
    Constant Field Values
  - LOG_HTML_BYTES
```
public static final int LOG_HTML_BYTES
```
    See Also:
    
    Constant Field Values
  - TRANS_CSV
```
public static final int TRANS_CSV
```
    See Also:
    
    Constant Field Values
  - TRANS_POJO
```
public static final int TRANS_POJO
```
    See Also:
    
    Constant Field Values
  - TRANS_BYTES
```
public static final int TRANS_BYTES
```
    See Also:
    
    Constant Field Values
  - TRANS_JSON
```
public static final int TRANS_JSON
```
    See Also:
    
    Constant Field Values
  - PDF_STATEMENT
```
public static final int PDF_STATEMENT
```
    See Also:
    
    Constant Field Values
  - PDF_TAX
```
public static final int PDF_TAX
```
    See Also:
    
    Constant Field Values
  - PDF_PL
```
public static final int PDF_PL
```
    See Also:
    
    Constant Field Values
  - PDF_BAL
```
public static final int PDF_BAL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OptionsPDF
```
public OptionsPDF()
```
    Default constructor
- Method Detail
  - setAccountType
```
public void setAccountType(java.lang.String accountType)
```
    Set the account type to be processed.
    
    Parameters:
    
    accountType - the account type, valid types are Bank, Invst, or CCard
  - setReadUSDates
```
public void setReadUSDates(boolean readUSDates)
```
    Set the format for reading dates
    
    Parameters:
    
    readUSDates - whether date formats are in US format (true) or EU format (false)
  - setWriteUSDates
```
public void setWriteUSDates(boolean writeUSDates)
```
    Set the format for writing dates to csv files
    
    Parameters:
    
    writeUSDates - whether output csv date formats are in US format (true) or EU format (false)
  - setStartAccount
```
public void setStartAccount(java.lang.String startAccount)
```
    Parameters:
    
    startAccount - regex that defines the start of the account to process, useful if multiple accounts
  - setEndAccount
```
public void setEndAccount(java.lang.String endAccount)
```
    Parameters:
    
    endAccount - regex that defines the end of the account to process, useful if multiple accounts
  - setSpacing
```
public void setSpacing(java.lang.Float spacing)
```
    Parameters:
    
    spacing - spacing factor for text that is very spread out or compressed. Default is 1.0, useful values range from .5 for closely packed text to 5.0 for text with lots of space
  - setPagewidth
```
public void setPagewidth(java.lang.Float pagewidth)
```
    Parameters:
    
    pagewidth - override pagewidth from what is specified in the PDF file. Some PDF files have extraneous text outside the supposedly visible limits.
  - setYear
```
public void setYear(int year)
```
    Parameters:
    
    year - override for the base year of the statement
  - setNeedAlphas
```
public boolean setNeedAlphas(boolean needalphas)
```
    Parameters:
    
    needalphas - set to false if transaction descriptions can just be an (account) number with no letters
    
    Returns:
    
    new value
  - getNeedAlphas
```
public boolean getNeedAlphas()
```
  - setNosepdates
```
public boolean setNosepdates(boolean nosepdates)
```
    Set the option for whether dates must have a separator. Normally true, set to false to have a string like 0102 to be considered as a date
    
    Parameters:
    
    nosepdates - set if dates have no separator,
    
    Returns:
    
    new value
  - getNosepdates
```
public boolean getNosepdates()
```
    Get the option for whether dates must have a separator.
  - setOnecurrencycol
```
public void setOnecurrencycol(boolean onecurrencycol)
```
    Parameters:
    
    onecurrencycol - Set if the statement should be considered as having a single currency column. Currently only needed for PNC Bank statements that use different columns for different kinds of debits.
  - setDoOCR
```
public boolean setDoOCR(boolean doOCR)
```
    Set the option for whether OCR should always be run, even if the PDF appears to be text based. May be needed if a previous OCR was done, or the PDF is encrypted.
    
    Parameters:
    
    doOCR - - true if should always run OCR.
  - getDoOCR
```
public boolean getDoOCR()
```
  - setDoOCRnr
```
public boolean setDoOCRnr(boolean doOCR)
```
    Set option for always running OCR if the statement did not reconcile with text processing. Differs from setDoOCR in that it always first tries text processing.
    
    Parameters:
    
    doOCRnr - - true if should always run OCR if the statement did not reconcile.
  - setFirstpage
```
public void setFirstpage(int firstpage)
```
    Set the first page in the PDF which should be processed. If not set, conversion starts on the first page.
    
    Parameters:
    
    firstpage - the first page number to process, the first page is 1
  - setLastpage
```
public void setLastpage(int lastpage)
```
    Set the last page in the PDF which should be processed. If not set, conversion continues to the end.
    
    Parameters:
    
    lastpage - the last page number to process
  - setDocType
```
public void setDocType(int doctype)
```
    Set the document type.
    
    Parameters:
    
    doctype - the document type. Options are PDF_STATEMENT, PDF_TAX. Default value is PDF_STATEMENT
  - getDocType
```
public int getDocType()
```
    Returns:
    
    the document type. returns PDF_STATEMENT, PDF_TAX
  - setFixedColumns
```
public void setFixedColumns(boolean fixedColumns)
```
    Set option for how columns are defined in a csv file
    
    Parameters:
    
    fixedColumns - true to output a fixed column layout rather than the columns layout from the statement, false to take column from PDF statement. The fixed column layout is Date, Payee, Amount, Memo, Check Number, Transaction Type.
  - setTrackingID
```
public void setTrackingID(java.lang.String trackingid)
```
    Set an optional tracking ID on the conversion.
    
    Parameters:
    
    trackingid - the trackingid to set. The use of this field is optional. If present it may be used to track the conversion request. It is also returned as part of the conversion results.
  - getTrackingID
```
public java.lang.String getTrackingID()
```
    Returns:
    
    the value previously set for Tracking ID
  - setPassword
```
public void setPassword(java.lang.String password)
```
    Set the password required to read a password protected PDF
    
    Parameters:
    
    password - the password to set
  - setCreateMap
```
public void setCreateMap(boolean createMap)
```
    Set option to create a .map file with page number and position of each transaction
    
    Parameters:
    
    createMap - value of flag
  - getCreateMap
```
public boolean getCreateMap()
```
    Return the value previously set for createMap
    
    Returns:
    
    the current value
  - getOutputType
```
public int getOutputType()
```
    Return the value of the output type
    
    Returns:
    
    returns the currently set output type
  - setOutputType
```
public void setOutputType(int outputType)
```
    Set the method for returning transactions
    
    Parameters:
    
    outputType - the method for returning transactions. TRANS_CSV to create a .csv file, TRANS_POJO to create a list of Java Transaction objects in ConverterResults. Default value is TRANS_CSV
  - setLogType
```
public void setLogType(int logType)
```
    Set the type of the log file
    
    Parameters:
    
    logType - the type of log file to create. LOG_NONE for no log, LOG_TXT for a readable text log, LOG_HTML for an html formatted log;
  - getLogType
```
public int getLogType()
```
    return the log type
    
    Returns:
    
    the log type previously set
  - setLogPath
```
public void setLogPath(java.io.File logPath)
```
    Set the path for the log file.
    
    Parameters:
    
    logPath - the full file spec for creating the log file. If blank, the input pdf path/file will be used with an appropriate extension
  - getLogPath
```
public java.io.File getLogPath()
```
    Get the current log path value
    
    Returns:
    
    the logPath
  - setAccountNumber
```
public void setAccountNumber(java.lang.String accountnumber)
```
    Set an account number to search for in the statement, used if the statement has multiple accounts
    
    Parameters:
    
    accountnumber - to search for.
  - getAccountnumber
```
public java.lang.String getAccountnumber()
```
    Get the current account number
    
    Returns:
    
    the accountnumber previously set
  - setRunOCRThread
```
public void setRunOCRThread(boolean runOCRThread)
```
    Flag for running OCR in a separate thread.
    
    Parameters:
    
    runOCRThread - set to true if OCR processing should be done on a separate thread. When this is set calls to PDFConvertServer.convert will return as soon as OCR processing is started. Use SetCallBack to set a call back when the OCR processing is complete. Also see setProgressUpdate
  - setCallBack
```
public void setCallBack(ConverterCallback callback)
```
    Set callback method for when OCR processing is complete
    
    Parameters:
    
    callback - The callback Method that is called when OCR processing has completed on another thread
  - setProgressupdate
```
public void setProgressupdate(BKProgressUpdate progressupdate)
```
    Deprecated. - use setProgressUpdate instead
  - setProgressUpdate
```
public void setProgressUpdate(ConverterSetProgress progressupdate)
```
    Set method to receive updates as the OCR processing proceeds
    
    Parameters:
    
    - - a method that implements the ConverterSetProgress interface to handle progress callbacks
  - getProgressUpdate
```
public ConverterSetProgress getProgressUpdate()
```
    Get the progress update methods
    
    Returns:
    
    the progress update method
  - setBankID
```
public void setBankID(java.lang.String bankid)
```
    Set the bankid to use when created OFX, QFX, QBO files
    
    Parameters:
    
    bankid - - For OFX, QFX, QBO files, the bankid to set in the file
  - getBankID
```
public java.lang.String getBankID()
```
    Get the current bankid
    
    Returns:
    
    the OFX bank ID previously set
  - setFid
```
public void setFid(java.lang.String fid)
```
    Set the Intuit FID, used by Quicken and QuickBooks in QBO and QFX files
    
    Parameters:
    
    fid - For QBO or QFX format, the fid to set in the file
  - setAccountSeq
```
public void setAccountSeq(int accountSequenceNnumber)
```
    Set which account to process if there are multiple accounts in a single statement
    
    Parameters:
    
    accountSequenceNnumber - - the account sequence number to search for. 1 is the first etc. 0 is to ignore multiple accounts and process all transactions. Setting the sequence number to -1 will process all accounts, but PDFConvertServer.convertMultiple has to be called in order to return multiple accounts.
  - getAccountSeq
```
public int getAccountSeq()
```
    Get the account sequence number
    
    Returns:
    
    the account sequence number
  - setStatementSeq
```
public void setStatementSeq(int statementSequenceNnumber)
```
    Deprecated. - use setMonthSeq instead
  - setMonthSeq
```
public void setMonthSeq(int monthSequenceNnumber)
```
    Set which statement to process if there are multiple (i.e. monthly) statements in the PDF
    
    Parameters:
    
    monthSequenceNnumber - - the month sequence number to search for. 1 for the first, 2 for the second etc. Setting the sequence number to -1 will process all monthly statements, but PDFConvertServer.convertMultiple has to be called in order to return multiple statements.
  - getStatementSeq
```
public int getStatementSeq()
```
    Get the statement sequence number
    
    Returns:
    
    the statement sequence number
  - getMonthSeq
```
public int getMonthSeq()
```
    Get the month sequence number
    
    Returns:
    
    the month sequence number
  - setLanguage
```
public void setLanguage(java.lang.String language)
```
    Set the language of the statement to process
    
    Parameters:
    
    language - the language to set - standard ISO language codes such as "en", "fr", "es" "de", "nl", 'il", "pt"
  - getLanguage
```
public java.lang.String getLanguage()
```
    Returns:
    
    the language
  - setCombineLines
```
public void setCombineLines(boolean combineLines)
```
    Set option to combine description lines
    
    Parameters:
    
    combineLines - - true to combine multiple description lines into a single payee, false to consider subsequent lines as the memo field
  - getCombineLines
```
public boolean getCombineLines()
```
    Get the combine lines flag
    
    Returns:
    
    the combineLines flag

Class OptionsPDF

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG_NONE

LOG_TXT

LOG_HTML

LOG_HTML_BYTES

TRANS_CSV

TRANS_POJO

TRANS_BYTES

TRANS_JSON

PDF_STATEMENT

PDF_TAX

PDF_PL

PDF_BAL

Constructor Detail

OptionsPDF

Method Detail

setAccountType

setReadUSDates

setWriteUSDates

setStartAccount

setEndAccount

setSpacing

setPagewidth

setYear

setNeedAlphas

getNeedAlphas

setNosepdates

getNosepdates

setOnecurrencycol

setDoOCR

getDoOCR

setDoOCRnr

setFirstpage

setLastpage

setDocType

getDocType

setFixedColumns

setTrackingID

getTrackingID

setPassword

setCreateMap

getCreateMap

getOutputType

setOutputType

setLogType

getLogType

setLogPath

getLogPath

setAccountNumber

getAccountnumber

setRunOCRThread

setCallBack

setProgressupdate

setProgressUpdate

getProgressUpdate

setBankID

getBankID

setFid

setAccountSeq

getAccountSeq

setStatementSeq

setMonthSeq

getStatementSeq

getMonthSeq

setLanguage

getLanguage

setCombineLines

getCombineLines