ExtractTemplate (Java API Reference for Oracle Hyperion Financial Management Release 11.2)

java.lang.Object
- oracle.epm.fm.domainobject.loadextract.ExtractTemplate

public class ExtractTemplate
extends Object

Constructor Summary

Constructors
Constructor and Description

ExtractTemplate()

Constructors
Constructor and Description
`ExtractTemplate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`createTemplateXML()` This method takes all the private members and turns them into xml that can be saved to the database.
`DATA_PUSH_OPTION`	`getDatabaseOption()` Returns wether to create, update, or delete a star schema
`String`	`getDelimiter()` The delimiter to be written in the extract file.
`String`	`getDestinationDatabase()` Returns the destination DSN.
`boolean`	`getExtractCellText()` Gets the option to extract cell text along with the data.
`boolean`	`getExtractData()` Gets whether or not data will be extracted
`boolean`	`getExtractDerivedData()` Gets the option to extract derived data along with the data.
`DATA_EXTRACT_TYPE_FLAG`	`getExtractFormat()` Returns how to extract the data.
`boolean`	`getExtractPhasedSubmission()` Gets the option to extract phased submission data along with the data.
`String`	`getFilePrefix()` Gets a string prefix that will be prepended to the data extract flat flie.
`DATA_LINEITEM_OPTION`	`getLineItemDetailOption()` Gets the option to extract line item details with the data.
`String`	`getPovToExtract()` Returns the selected POV to extract.
`String`	`getTablePrefix()` Returns the table prefix to prepend to the database tables.
`String`	`getTemplateName()` The name of the template to be saved to the database.
`boolean`	`isExtractCalculatedData()` Returns true if we should extract calculated data, false otherwise.
`boolean`	`isExtractDynamicAccounts()` Returns true if we should extract dynamic accounts, false otherwise.
`void`	`setDatabaseOption(DATA_PUSH_OPTION databaseOption)` What action should be run on the schema: Create, Delete, Update.
`void`	`setDelimiter(String delimiter)` The delimiter to be written in the extract file.
`void`	`setDestinationDatabase(String destinationDatabase)` The DSN to extract the data to.
`void`	`setExtractCalculatedData(boolean extractCalculatedData)` Sets extract whether or not we should extract calculated data or not.
`void`	`setExtractCellText(boolean extractCellText)` Sets the option to extract cell text along with the data.
`void`	`setExtractData(boolean extractData)` Sets whether or not data will be extracted
`void`	`setExtractDerivedData(boolean extractDerivedData)` Sets the option to extract derived data along with the data.
`void`	`setExtractDynamicAccounts(boolean extractDynamicAccounts)` Sets extract whether or not we should extract dynamic accounts or not.
`void`	`setExtractFormat(DATA_EXTRACT_TYPE_FLAG extractFormat)` Sets extract format (With Header, Without Header, Essbase, Metadata Only, ...)
`void`	`setExtractPhasedSubmission(boolean extractPhasedSubmission)` Sets the option to extract phased submission data along with the data.
`void`	`setFilePrefix(String filePrefix)` Sets a string prefix that will be prepended to the data extract flat flie.
`void`	`setLineItemDetailOption(DATA_LINEITEM_OPTION lineItemDetailOption)` Sets the option to extract line item details with the data.
`void`	`setPovToExtract(String povToExtract)` This will set the POV of data to be extracted.
`void`	`setTablePrefix(String tablePrefix)` This string will be used to add a prefix to the table names.
`void`	`setTemplateName(String templateName)` The name of the template to be saved to the database.

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

- Constructor Detail
  - ExtractTemplate
```
public ExtractTemplate()
```
- Method Detail
  - setExtractFormat
```
public void setExtractFormat(DATA_EXTRACT_TYPE_FLAG extractFormat)
```
    Sets extract format (With Header, Without Header, Essbase, Metadata Only, ...)
    
    Parameters:
    
    extractFormat -
  - setExtractCalculatedData
```
public void setExtractCalculatedData(boolean extractCalculatedData)
```
    Sets extract whether or not we should extract calculated data or not.
    
    Parameters:
    
    extractCalculatedData -
  - setExtractDynamicAccounts
```
public void setExtractDynamicAccounts(boolean extractDynamicAccounts)
```
    Sets extract whether or not we should extract dynamic accounts or not.
    
    Parameters:
    
    extractDynamicAccounts -
  - setPovToExtract
```
public void setPovToExtract(String povToExtract)
```
    This will set the POV of data to be extracted.
    
    Parameters:
    
    povToExtract -
  - setTablePrefix
```
public void setTablePrefix(String tablePrefix)
```
    This string will be used to add a prefix to the table names.
    
    Parameters:
    
    tablePrefix -
  - setDestinationDatabase
```
public void setDestinationDatabase(String destinationDatabase)
```
    The DSN to extract the data to.
    
    Parameters:
    
    destinationDatabase -
  - setTemplateName
```
public void setTemplateName(String templateName)
```
    The name of the template to be saved to the database.
    
    Parameters:
    
    templateName -
  - getTemplateName
```
public String getTemplateName()
```
    The name of the template to be saved to the database.
    
    Returns:
    
    the name of the template to be saved
  - setDatabaseOption
```
public void setDatabaseOption(DATA_PUSH_OPTION databaseOption)
```
    What action should be run on the schema: Create, Delete, Update.
    
    Parameters:
    
    databaseOption -
  - getDatabaseOption
```
public DATA_PUSH_OPTION getDatabaseOption()
```
    Returns wether to create, update, or delete a star schema
  - getExtractFormat
```
public DATA_EXTRACT_TYPE_FLAG getExtractFormat()
```
    Returns how to extract the data. Without header, with header, Essbase, data warehouse.
  - isExtractCalculatedData
```
public boolean isExtractCalculatedData()
```
    Returns true if we should extract calculated data, false otherwise.
  - isExtractDynamicAccounts
```
public boolean isExtractDynamicAccounts()
```
    Returns true if we should extract dynamic accounts, false otherwise.
  - getTablePrefix
```
public String getTablePrefix()
```
    Returns the table prefix to prepend to the database tables.
  - getPovToExtract
```
public String getPovToExtract()
```
    Returns the selected POV to extract.
  - getDestinationDatabase
```
public String getDestinationDatabase()
```
    Returns the destination DSN.
  - setFilePrefix
```
public void setFilePrefix(String filePrefix)
```
    Sets a string prefix that will be prepended to the data extract flat flie.
    
    Parameters:
    
    filePrefix - the string to prefix to the flat file.
  - getFilePrefix
```
public String getFilePrefix()
```
    Gets a string prefix that will be prepended to the data extract flat flie.
    
    Returns:
    
    the string to prefix to the flat file.
  - setExtractCellText
```
public void setExtractCellText(boolean extractCellText)
```
    Sets the option to extract cell text along with the data. True if you want to extract, false otherwise.
    
    Parameters:
    
    extractCellText - True if you want to extract cell text, false otherwise.
  - getExtractCellText
```
public boolean getExtractCellText()
```
    Gets the option to extract cell text along with the data. True if you want to extract, false otherwise.
    
    Returns:
    
    True if you want to extract cell text, false otherwise.
  - setExtractPhasedSubmission
```
public void setExtractPhasedSubmission(boolean extractPhasedSubmission)
```
    Sets the option to extract phased submission data along with the data. True if you want to extract, false otherwise.
    
    Parameters:
    
    extractPhasedSubmission - True if you want to extract phased submission info, false otherwise.
  - getExtractPhasedSubmission
```
public boolean getExtractPhasedSubmission()
```
    Gets the option to extract phased submission data along with the data. True if you want to extract, false otherwise.
    
    Returns:
    
    True if you want to extract phased submission info, false otherwise.
  - setExtractDerivedData
```
public void setExtractDerivedData(boolean extractDerivedData)
```
    Sets the option to extract derived data along with the data. True if you want to extract, false otherwise.
    
    Parameters:
    
    extractDerivedData - True if you want to extract derived data, false otherwise.
  - getExtractDerivedData
```
public boolean getExtractDerivedData()
```
    Gets the option to extract derived data along with the data. True if you want to extract, false otherwise.
    
    Returns:
    
    True if you want to extract derived data, false otherwise.
  - setLineItemDetailOption
```
public void setLineItemDetailOption(DATA_LINEITEM_OPTION lineItemDetailOption)
```
    Sets the option to extract line item details with the data. True if you want to extract, false otherwise.
    
    Parameters:
    
    lineItemDetailOption - True if you want to line item details, false otherwise.
  - getLineItemDetailOption
```
public DATA_LINEITEM_OPTION getLineItemDetailOption()
```
    Gets the option to extract line item details with the data. True if you want to extract, false otherwise.
    
    Returns:
    
    True if you want to line item details, false otherwise.
  - setDelimiter
```
public void setDelimiter(String delimiter)
```
    The delimiter to be written in the extract file. It should be one character long.
    
    Parameters:
    
    delimiter - the delimiter to be written in the extract file.
  - getDelimiter
```
public String getDelimiter()
```
    The delimiter to be written in the extract file. It should be one character long.
    
    Returns:
    
    the delimiter to be written in the extract file
  - setExtractData
```
public void setExtractData(boolean extractData)
```
    Sets whether or not data will be extracted
    
    Parameters:
    
    extractData - true if data is to be extracted, false otherwise
  - getExtractData
```
public boolean getExtractData()
```
    Gets whether or not data will be extracted
    
    Returns:
    
    true if data is to be extracted, false otherwise
  - createTemplateXML
```
public String createTemplateXML()
```
    This method takes all the private members and turns them into xml that can be saved to the database.
    
    Returns:
    
    XML as a string that can be used as a template definition.

Class ExtractTemplate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExtractTemplate

Method Detail

setExtractFormat

setExtractCalculatedData

setExtractDynamicAccounts

setPovToExtract

setTablePrefix

setDestinationDatabase

setTemplateName

getTemplateName

setDatabaseOption

getDatabaseOption

getExtractFormat

isExtractCalculatedData

isExtractDynamicAccounts

getTablePrefix

getPovToExtract

getDestinationDatabase

setFilePrefix

getFilePrefix

setExtractCellText

getExtractCellText

setExtractPhasedSubmission

getExtractPhasedSubmission

setExtractDerivedData

getExtractDerivedData

setLineItemDetailOption

getLineItemDetailOption

setDelimiter

getDelimiter

setExtractData

getExtractData

createTemplateXML