HmfhExportSpec (EBX® Add-ons Version 4.5.9 Java API)

java.lang.Object
- com.orchestranetworks.addon.hmfh.HmfhSpec
- - com.orchestranetworks.addon.hmfh.HmfhExportSpec

public final class HmfhExportSpec
extends HmfhSpec

Defines the features of a Hyperion export.

Constructor Summary

Constructors
Constructor and Description

HmfhExportSpec()

Constructors
Constructor and Description
`HmfhExportSpec()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`BooleanFormat`	`getBooleanFormat()` Deprecated. use `getBooleanFormatEntity()` instead.
`BooleanFormatEntity`	`getBooleanFormatEntity()` Returns the format of the exported boolean fields.
`CSVDelimiter`	`getCsvDelimiter()` Deprecated. Use `getCSVDelimiter()` instead. This method will be deleted in further versions.
`CSVDelimiter`	`getCSVDelimiter()` Returns the delimiter used in the CSV file.
`String`	`getDecimalFormat()` Returns the export format for the 'AggregationWeight' field in the 'Custom' dimension.
`com.orchestranetworks.addon.hmfh.HmfhExportFlatADSSpec`	`getExportFlatADSSpec()` Returns `HmfhExportFlatADSSpec` for exported ADS files.
`HmfhExportFlatCSVSpec`	`getExportFlatCSVSpec()` Returns `HmfhExportFlatCSVSpec` for exported CSV flat files.
`String`	`getExportType()` Returns the export type.
`List<FileExtension>`	`getFileExtensions()` Returns the list of file extensions for export.
`String`	`getFlatCSVversion()` Returns the version of the CSV flat file.
`String`	`getHeaderOfDefaultParentColumnInFlatCSV()` Returns the header label of the 'Default Parent' column in the CSV flat file.
`String`	`getHeaderOfDescriptionColumnInFlatCSV()` Returns the header label of the 'Description' column in the exported CSV flat file.
`ExportHierarchyOrder`	`getHierarchyOrderType()` Returns the `ExportHierarchyOrder` type.
`int`	`getMinimumNumberOfGeneratedLevels()` Returns the minimum number of dynamically generated levels when exporting in the Excel format.
`List<ADSSectionEnumeration>`	`getSections()` Returns ADS sections enumeration.
`StartingNodes`	`getStartingNodes()` Returns the nodes to export data from.
`String`	`getVersion()` Returns the version of Hyperion HFM.
`boolean`	`isExportCustomOrderInFlatCSV()` Returns `true` if 'CUSTOM_ORDER' is included in the exported flat CSV file.
`boolean`	`isExportEmptyFieldAppSetting()` Returns `true` if the empty fields in the 'Application setting' table are exported to CSV flat files.
`boolean`	`isExportFromStartingNodes()` Returns `true` if exporting from starting nodes.
`boolean`	`isExportFullRelationship()` Returns `true` if the exported Excel file includes all relationship nodes.
`boolean`	`isExportHierarchyHeaderInFlatCSV()` Returns `true` if CSV flat files include the header information of the hierarchy.
`boolean`	`isExportingALL()` Returns `true` if 'ALL' members of the 'Custom' dimensions are being exported.
`boolean`	`isExportRootInCSVFlatFile()` Returns `true` if `#root` is exported to a CSV Flat files.
`void`	`setBooleanFormat(BooleanFormat booleanFormat)` Deprecated. use `setBooleanFormatEntity(com.orchestranetworks.addon.hmfh.BooleanFormatEntity)` instead.
`void`	`setBooleanFormatEntity(BooleanFormatEntity booleanFormatEntity)` Defines the format of the exported boolean fields.
`void`	`setCsvDelimiter(CSVDelimiter csvDelimiter)` Specifies the delimiter used in the CSV file.
`void`	`setDecimalFormat(String decimalFormat)` Defines the export format for the 'AggregationWeight' field in the 'Custom' dimension.
`void`	`setExportCustomOrderInFlatCSV(boolean exportCustomOrder)` Specifies 'CUSTOM_ORDER' in exported CSV flat files.
`void`	`setExportEmptyFieldAppSetting(boolean exportEmptyFieldAppSetting)` Specifies whether empty fields in the 'Application Setting' table are exported when exporting to CSV flat file.
`void`	`setExportFlatADSSpec(com.orchestranetworks.addon.hmfh.HmfhExportFlatADSSpec exportFlatADSSpec)` Specifies `HmfhExportFlatADSSpec` for exported ADS files.
`void`	`setExportFlatCSVSpec(HmfhExportFlatCSVSpec exportFlatCSVSpec)` Specifies `HmfhExportFlatCSVSpec` for exported flat CSV files.
`void`	`setExportFromStartingNodes()` Activates the export from starting nodes.
`void`	`setExportFullRelationship(boolean exportFullRelationship)` Determines whether all relationship nodes declarations are exported when exporting to Excel.
`void`	`setExportHierarchyHeaderInFlatCSV(boolean exportHierarchyHeaderInFlatCSV)` Specifies the header information of hierarchy.
`void`	`setExportingALL(boolean exportingALL)` Enables or disables export for 'ALL' members of the 'Custom' dimensions.
`void`	`setExportRootInCSVFlatFile(boolean exportRootInCSVFlatFile)` Determines whether the `#root` record gets exported during CSV Flat file export.
`void`	`setExportType(String exportType)` Specifies the export type.
`void`	`setFileExtensions(List<FileExtension> fileExtensions)` Specifies the list of file extensions for export.
`void`	`setFlatCSVversion(String flatCSVversion)` Specifies the version of the CSV flat file.
`void`	`setHeaderOfDefaultParentColumnInFlatCSV(String headerOfDefaultParentColumnInFlatCSV)` Specifies the header label for the 'Default Parent' column in the exported CSV flat files.
`void`	`setHeaderOfDescriptionColumnInFlatCSV(String headerOfDescriptionColumnInFlatCSV)` Specifies the header label of the 'Description' column in the exported CSV flat file.
`void`	`setHierarchyOrderType(ExportHierarchyOrder hierarchyOrderType)` Determines the hierarchy order in the exported file when using the Hyperion export service.
`void`	`setMinimumNumberOfGeneratedLevels(int minimumGeneratedLevels)` Specifies the minimum number of dynamically generated levels when exporting in the Excel format.
`void`	`setSections(List<ADSSectionEnumeration> sections)` Sets ADS sections enumeration.
`void`	`setVersion(String version)` Specifies the version of Hyperion HFM.

Methods inherited from class com.orchestranetworks.addon.hmfh.HmfhSpec
getApplication, getCurrentDataset, getCurrentLocale, getDatasetMapping, getDimensions, isUsingLog, setApplication, setCurrentDataset, setCurrentLocale, setDatasetMapping, setDimensions, setUsingLog, toString

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

- Constructor Detail
  - HmfhExportSpec
```
public HmfhExportSpec()
```
- Method Detail
  - setExportFlatCSVSpec
```
public void setExportFlatCSVSpec(HmfhExportFlatCSVSpec exportFlatCSVSpec)
```
    Specifies HmfhExportFlatCSVSpec for exported flat CSV files.
    
    Parameters:
    
    exportFlatCSVSpec - the definition of the export
    
    Since:
    
    1.5.0
  - setExportFlatADSSpec
```
public void setExportFlatADSSpec(com.orchestranetworks.addon.hmfh.HmfhExportFlatADSSpec exportFlatADSSpec)
```
    Specifies HmfhExportFlatADSSpec for exported ADS files.
    
    Parameters:
    
    exportFlatADSSpec - the definition of the export
    
    Since:
    
    1.6.2
  - setExportRootInCSVFlatFile
```
public void setExportRootInCSVFlatFile(boolean exportRootInCSVFlatFile)
```
    Determines whether the #root record gets exported during CSV Flat file export. This property only applies when exporting CSV Flat files.
    
    Parameters:
    
    exportRootInCSVFlatFile - true if #root is exported to CSV flat file, false otherwise.
  - isExportRootInCSVFlatFile
```
public boolean isExportRootInCSVFlatFile()
```
    Returns true if #root is exported to a CSV Flat files. Otherwise, it returns false.
  - getCsvDelimiter
```
public CSVDelimiter getCsvDelimiter()
```
    Deprecated. Use getCSVDelimiter() instead. This method will be deleted in further versions.
    
    Returns the delimiter used in the CSV file.
  - getCSVDelimiter
```
public CSVDelimiter getCSVDelimiter()
```
    Returns the delimiter used in the CSV file.
  - setCsvDelimiter
```
public void setCsvDelimiter(CSVDelimiter csvDelimiter)
```
    Specifies the delimiter used in the CSV file.
    
    Parameters:
    
    csvDelimiter - Delimiter is used in exported file.
  - getFlatCSVversion
```
public String getFlatCSVversion()
```
    Returns the version of the CSV flat file.
  - setFlatCSVversion
```
public void setFlatCSVversion(String flatCSVversion)
```
    Specifies the version of the CSV flat file.
    
    Parameters:
    
    flatCSVversion - version to be set to exported flat CSV file.
  - getVersion
```
public String getVersion()
```
    Returns the version of Hyperion HFM.
  - setVersion
```
public void setVersion(String version)
```
    Specifies the version of Hyperion HFM.
    
    Parameters:
    
    version - version to be set to HFM file.
  - getExportType
```
public String getExportType()
```
    Returns the export type.
  - setExportType
```
public void setExportType(String exportType)
```
    Specifies the export type.
    
    Parameters:
    
    exportType - type of exporting.
  - getFileExtensions
```
public List<FileExtension> getFileExtensions()
```
    Returns the list of file extensions for export.
  - setFileExtensions
```
public void setFileExtensions(List<FileExtension> fileExtensions)
```
    Specifies the list of file extensions for export.
    
    Parameters:
    
    fileExtensions - list of extension file.
  - setExportEmptyFieldAppSetting
```
public void setExportEmptyFieldAppSetting(boolean exportEmptyFieldAppSetting)
```
    Specifies whether empty fields in the 'Application Setting' table are exported when exporting to CSV flat file.
    
    Parameters:
    
    exportEmptyFieldAppSetting - true if empty fields in 'Application setting' table are exported, false otherwise.
  - isExportEmptyFieldAppSetting
```
public boolean isExportEmptyFieldAppSetting()
```
    Returns true if the empty fields in the 'Application setting' table are exported to CSV flat files. Otherwise, it returns false.
  - setExportFullRelationship
```
public void setExportFullRelationship(boolean exportFullRelationship)
```
    Determines whether all relationship nodes declarations are exported when exporting to Excel.
    
    Parameters:
    
    exportFullRelationship - true if full relationship is exported, false otherwise.
  - isExportFullRelationship
```
public boolean isExportFullRelationship()
```
    Returns true if the exported Excel file includes all relationship nodes. Otherwise, it returns false.
  - setHeaderOfDefaultParentColumnInFlatCSV
```
public void setHeaderOfDefaultParentColumnInFlatCSV(String headerOfDefaultParentColumnInFlatCSV)
```
    Specifies the header label for the 'Default Parent' column in the exported CSV flat files.
    
    Parameters:
    
    headerOfDefaultParentColumnInFlatCSV - default parent column name in CSV flat file.
    
    Since:
    
    1.5.0
  - getHeaderOfDefaultParentColumnInFlatCSV
```
public String getHeaderOfDefaultParentColumnInFlatCSV()
```
    Returns the header label of the 'Default Parent' column in the CSV flat file.
    
    Since:
    
    1.5.0
  - setHeaderOfDescriptionColumnInFlatCSV
```
public void setHeaderOfDescriptionColumnInFlatCSV(String headerOfDescriptionColumnInFlatCSV)
```
    Specifies the header label of the 'Description' column in the exported CSV flat file.
    
    Parameters:
    
    headerOfDescriptionColumnInFlatCSV - header name to be set to description column in CVS flat file.
    
    Since:
    
    1.5.0
  - getHeaderOfDescriptionColumnInFlatCSV
```
public String getHeaderOfDescriptionColumnInFlatCSV()
```
    Returns the header label of the 'Description' column in the exported CSV flat file.
    
    Since:
    
    1.5.0
  - isExportHierarchyHeaderInFlatCSV
```
public boolean isExportHierarchyHeaderInFlatCSV()
```
    Returns true if CSV flat files include the header information of the hierarchy. Otherwise, it returns false.
    
    Since:
    
    1.5.0
  - setExportHierarchyHeaderInFlatCSV
```
public void setExportHierarchyHeaderInFlatCSV(boolean exportHierarchyHeaderInFlatCSV)
```
    Specifies the header information of hierarchy.
    
    Parameters:
    
    exportHierarchyHeaderInFlatCSV - true if the CSV flat file includes header information of hierarchy, false if header information of hierarchy is excluded in the CSV flat file.
    
    Since:
    
    1.5.0
  - getExportFlatCSVSpec
```
public HmfhExportFlatCSVSpec getExportFlatCSVSpec()
```
    Returns HmfhExportFlatCSVSpec for exported CSV flat files.
    
    Since:
    
    1.5.0
  - getExportFlatADSSpec
```
public com.orchestranetworks.addon.hmfh.HmfhExportFlatADSSpec getExportFlatADSSpec()
```
    Returns HmfhExportFlatADSSpec for exported ADS files.
    
    Since:
    
    1.6.2
  - getSections
```
public List<ADSSectionEnumeration> getSections()
```
    Returns ADS sections enumeration.
    
    Since:
    
    1.6.0
  - setSections
```
public void setSections(List<ADSSectionEnumeration> sections)
```
    Sets ADS sections enumeration.
    
    Parameters:
    
    sections - ADS sections enumeration.
    
    Since:
    
    1.6.0
  - isExportCustomOrderInFlatCSV
```
public boolean isExportCustomOrderInFlatCSV()
```
    Returns true if 'CUSTOM_ORDER' is included in the exported flat CSV file. Otherwise, it returns false.
    
    Since:
    
    1.5.0
  - setExportCustomOrderInFlatCSV
```
public void setExportCustomOrderInFlatCSV(boolean exportCustomOrder)
```
    Specifies 'CUSTOM_ORDER' in exported CSV flat files.
    
    Parameters:
    
    exportCustomOrder - true if 'CUSTOM_ORDER' is included in the CSV flat file, false 'CUSTOM_ORDER' is excluded in the CSV flat file.
    
    Since:
    
    1.5.0
  - getDecimalFormat
```
public String getDecimalFormat()
```
    Returns the export format for the 'AggregationWeight' field in the 'Custom' dimension.
  - setDecimalFormat
```
public void setDecimalFormat(String decimalFormat)
```
    Defines the export format for the 'AggregationWeight' field in the 'Custom' dimension. This format is defined as 'Java - Decimal Format'. The value must conform to the regular expression "[-]?[0#,]+[.]?[0#]*[E]?[0]*".
    
    Parameters:
    
    decimalFormat - the decimal format to use
    
    Since:
    
    1.5.0
  - getHierarchyOrderType
```
public ExportHierarchyOrder getHierarchyOrderType()
```
    Returns the ExportHierarchyOrder type.
    
    Since:
    
    1.5.0
  - setHierarchyOrderType
```
public void setHierarchyOrderType(ExportHierarchyOrder hierarchyOrderType)
```
    Determines the hierarchy order in the exported file when using the Hyperion export service. 'Order using Child order': the hierarchy order is the determined from the field 'Child order'. This field is located on the hierarchy tables in the financial data set (for example, Account hierarchy, Custom1 hierarchy, etc.). 'Same order as Data hierarchy view': the hierarchy order follows the one displayed in the data hierarchy view.
    
    Parameters:
    
    hierarchyOrderType - Hierarchy order type used in exported file.
    
    Since:
    
    1.5.0
  - getStartingNodes
```
public StartingNodes getStartingNodes()
```
    Returns the nodes to export data from.
    
    Since:
    
    1.8.0
  - isExportFromStartingNodes
```
public boolean isExportFromStartingNodes()
```
    Returns true if exporting from starting nodes.
    
    Since:
    
    1.8.0
  - setExportFromStartingNodes
```
public void setExportFromStartingNodes()
```
    Activates the export from starting nodes.
    
    Since:
    
    1.8.0
  - isExportingALL
```
public boolean isExportingALL()
```
    Returns true if 'ALL' members of the 'Custom' dimensions are being exported.
    
    Since:
    
    1.9.0
  - setExportingALL
```
public void setExportingALL(boolean exportingALL)
```
    Enables or disables export for 'ALL' members of the 'Custom' dimensions.
    
    Since:
    
    1.9.0
  - getMinimumNumberOfGeneratedLevels
```
public int getMinimumNumberOfGeneratedLevels()
```
    Returns the minimum number of dynamically generated levels when exporting in the Excel format.
    
    Since:
    
    1.9.0
  - setMinimumNumberOfGeneratedLevels
```
public void setMinimumNumberOfGeneratedLevels(int minimumGeneratedLevels)
```
    Specifies the minimum number of dynamically generated levels when exporting in the Excel format.
    
    Since:
    
    1.9.0
  - getBooleanFormat
```
public BooleanFormat getBooleanFormat()
```
    Deprecated. use getBooleanFormatEntity() instead.
    
    Returns the format of the exported boolean fields.
    
    Since:
    
    1.9.0
  - setBooleanFormat
```
public void setBooleanFormat(BooleanFormat booleanFormat)
```
    Deprecated. use setBooleanFormatEntity(com.orchestranetworks.addon.hmfh.BooleanFormatEntity) instead.
    
    Defines the format of the exported boolean fields.
    
    Parameters:
    
    booleanFormat - sets the boolean format to display
    
    Since:
    
    1.9.0
  - getBooleanFormatEntity
```
public BooleanFormatEntity getBooleanFormatEntity()
```
    Returns the format of the exported boolean fields.
    
    Since:
    
    1.11.0
  - setBooleanFormatEntity
```
public void setBooleanFormatEntity(BooleanFormatEntity booleanFormatEntity)
```
    Defines the format of the exported boolean fields.
    
    Parameters:
    
    booleanFormatEntity - sets the boolean format to display
    
    Since:
    
    1.11.0

Add-ons Version 4.5.9.

Copyright TIBCO Software Inc. 2001-2022. All rights reserved.
All third party product and company names and third party marks mentioned in this document are the property of their respective owners and are mentioned for identification.

Class HmfhExportSpec

Constructor Summary

Method Summary

Methods inherited from class com.orchestranetworks.addon.hmfh.HmfhSpec

Methods inherited from class java.lang.Object

Constructor Detail

HmfhExportSpec

Method Detail

setExportFlatCSVSpec

setExportFlatADSSpec

setExportRootInCSVFlatFile

isExportRootInCSVFlatFile

getCsvDelimiter

getCSVDelimiter

setCsvDelimiter

getFlatCSVversion

setFlatCSVversion

getVersion

setVersion

getExportType

setExportType

getFileExtensions

setFileExtensions

setExportEmptyFieldAppSetting

isExportEmptyFieldAppSetting

setExportFullRelationship

isExportFullRelationship

setHeaderOfDefaultParentColumnInFlatCSV

getHeaderOfDefaultParentColumnInFlatCSV

setHeaderOfDescriptionColumnInFlatCSV

getHeaderOfDescriptionColumnInFlatCSV

isExportHierarchyHeaderInFlatCSV

setExportHierarchyHeaderInFlatCSV

getExportFlatCSVSpec

getExportFlatADSSpec

getSections

setSections

isExportCustomOrderInFlatCSV

setExportCustomOrderInFlatCSV

getDecimalFormat

setDecimalFormat

getHierarchyOrderType

setHierarchyOrderType

getStartingNodes

isExportFromStartingNodes

setExportFromStartingNodes

isExportingALL

setExportingALL

getMinimumNumberOfGeneratedLevels

setMinimumNumberOfGeneratedLevels

getBooleanFormat

setBooleanFormat

getBooleanFormatEntity

setBooleanFormatEntity