com.orchestranetworks.addon.hmfh

Class HmfhExportFlatCSVSpec

java.lang.Object

com.orchestranetworks.addon.hmfh.HmfhExportFlatCSVSpec

public class HmfhExportFlatCSVSpec
extends Object

Defines the exported CSV file.

Since:

1.5.0

Constructor Summary

Constructors

Constructor and Description
HmfhExportFlatCSVSpec()

Method Summary

Modifier and Type	Method and Description
String	getFlatCSVversion() Returns the 'Version' used by the export procedure for HFM flat CSV files.
String	getHeaderOfDefaultParentColumn() Returns the header label of the 'Default Parent' column in the exported flat CSV file.
String	getHeaderOfDescriptionColumn() Returns the header label of the 'Description' column in the exported flat CSV file.
boolean	isExportCustomOrder() Returns true if 'CUSTOM_ORDER' is included in the exported flat CSV file, otherwise returns false.
boolean	isExportEmptyFieldAppSetting() Returns true if empty fields in the 'Application Setting' table are exported to the flat CSV file, otherwise returns false.
boolean	isExportHierarchyHeader() Returns true if the header information of hierarchy nodes is included when exporting to flat CSV file, otherwise returns false.
boolean	isExportRootInCSVFlatFile() Returns true if #root is exported to the flat CSV file, otherwise returns false.
void	setExportCustomOrder(boolean exportCustomOrder) Specifies 'CUSTOM_ORDER' information in the exported flat CSV file.
void	setExportEmptyFieldAppSetting(boolean exportEmptyFieldAppSetting) Specifies to export empty fields in the 'Application Setting' table.
void	setExportHierarchyHeader(boolean exportHierarchyHeader) Specifies the exported header information of flat CSV files.
void	setExportRootInCSVFlatFile(boolean exportRootInCSVFlatFile) Specifies to export #root in flat CSV files.
void	setFlatCSVversion(String flatCSVversion) Defines the field 'Version' used by the export procedure for HFM flat CSV files.
void	setHeaderOfDefaultParentColumn(String headerOfDefaultParentColumn) Specifies the header label of the 'Default Parent' column in the exported flat CSV file.
void	setHeaderOfDescriptionColumn(String headerOfDescriptionColumn) Specifies header label of the 'Description' column in the exported flat CSV file.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HmfhExportFlatCSVSpec

public HmfhExportFlatCSVSpec()

Method Detail

getFlatCSVversion

public String getFlatCSVversion()

Returns the 'Version' used by the export procedure for HFM flat CSV files.

setFlatCSVversion

public void setFlatCSVversion(String flatCSVversion)

Defines the field 'Version' used by the export procedure for HFM flat CSV files.

Parameters:

flatCSVversion - version will be set to exported CSV file.

isExportRootInCSVFlatFile

public boolean isExportRootInCSVFlatFile()

Returns true if #root is exported to the flat CSV file, otherwise returns false.

setExportRootInCSVFlatFile

public void setExportRootInCSVFlatFile(boolean exportRootInCSVFlatFile)

Specifies to export #root in flat CSV files.

Parameters:

exportRootInCSVFlatFile - true include #root in exported flat CSV files false exclude #root in exported flat CSV files.

isExportEmptyFieldAppSetting

public boolean isExportEmptyFieldAppSetting()

Returns true if empty fields in the 'Application Setting' table are exported to the flat CSV file, otherwise returns false.

setExportEmptyFieldAppSetting

public void setExportEmptyFieldAppSetting(boolean exportEmptyFieldAppSetting)

Specifies to export empty fields in the 'Application Setting' table.

Parameters:

exportEmptyFieldAppSetting - true if empty fields in 'Application Setting' table are included when exporting to flat CSV file falseempty fields in 'Application Setting' table are excluded when exporting to flat CSV file

getHeaderOfDefaultParentColumn

public String getHeaderOfDefaultParentColumn()

Returns the header label of the 'Default Parent' column in the exported flat CSV file.

setHeaderOfDefaultParentColumn

public void setHeaderOfDefaultParentColumn(String headerOfDefaultParentColumn)

Specifies the header label of the 'Default Parent' column in the exported flat CSV file.

Parameters:

headerOfDefaultParentColumn - header name to be set to default parent column.

getHeaderOfDescriptionColumn

public String getHeaderOfDescriptionColumn()

Returns the header label of the 'Description' column in the exported flat CSV file.

setHeaderOfDescriptionColumn

public void setHeaderOfDescriptionColumn(String headerOfDescriptionColumn)

Specifies header label of the 'Description' column in the exported flat CSV file.

Parameters:

headerOfDescriptionColumn - header name will be set to description column.

isExportHierarchyHeader

public boolean isExportHierarchyHeader()

Returns true if the header information of hierarchy nodes is included when exporting to flat CSV file, otherwise returns false.

setExportHierarchyHeader

public void setExportHierarchyHeader(boolean exportHierarchyHeader)

Specifies the exported header information of flat CSV files.

Parameters:

exportHierarchyHeader - true if hierarchy header is exported, false otherwise.

isExportCustomOrder

public boolean isExportCustomOrder()

Returns true if 'CUSTOM_ORDER' is included in the exported flat CSV file, otherwise returns false.

setExportCustomOrder

public void setExportCustomOrder(boolean exportCustomOrder)

Specifies 'CUSTOM_ORDER' information in the exported flat CSV file.

Parameters:

exportCustomOrder - true if custom order is exported, false otherwise.