com.orchestranetworks.addon.hmfh

Class HmfhImportSpec

java.lang.Object

com.orchestranetworks.addon.hmfh.HmfhSpec

com.orchestranetworks.addon.hmfh.HmfhImportSpec

public final class HmfhImportSpec
extends HmfhSpec

Defines the features of a Hyperion import.

Constructor Summary

Constructors

Constructor and Description
HmfhImportSpec()

Method Summary

Modifier and Type	Method and Description
CSVDelimiter	getADSDelimiter() Returns the delimiter is used in the ADS file.
ApplicationStructure	getApplicationStructure() Returns the current application structure.
BehaviorOfImportEmptyValue	getBehaviorOfImportEmptyValue() Returns the behavior of import empty value.
FileExtension	getFileExtension() Returns the list of file extensions available for import.
String	getFileName() Returns the name of the current file.
String	getFilePath() Returns the path of the current file.
ImportType	getImportType() Returns the type of the current import.
boolean	isDeleteOldLog()
boolean	isUpdateOrdering()
void	setADSDelimiter(CSVDelimiter delimiter) Specifies the delimiter used in the ADS file.
void	setApplicationStructure(ApplicationStructure applicationStructure) Sets the current application structure.
void	setBehaviorOfImportEmptyValue(BehaviorOfImportEmptyValue behaviorOfImportEmptyValue) Sets the behavior of import empty value.
void	setDeleteOldLog(boolean deleteOldLog) Defines whether or not old logs will be deleted; this property is only used when using Hmfh logging.
void	setFileName(String fileName) Sets the name of the current file.
void	setFilePath(String filePath) Sets the path of the current file.
void	setImportType(ImportType importType) Sets the type of the current import.
void	setImportType(String importType) Specifies the type of the current import from its String value.
void	setUpdateOrdering(boolean isUpdateOrdering) Defines whether or not to update the order of dimensions, attributes, etc, when importing.

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

HmfhImportSpec

public HmfhImportSpec()

Method Detail

getBehaviorOfImportEmptyValue

public BehaviorOfImportEmptyValue getBehaviorOfImportEmptyValue()

Returns the behavior of import empty value.

Since:

1.6.0

setBehaviorOfImportEmptyValue

public void setBehaviorOfImportEmptyValue(BehaviorOfImportEmptyValue behaviorOfImportEmptyValue)

Sets the behavior of import empty value.

Parameters:

behaviorOfImportEmptyValue - behavior of import empty value to be set.

Since:

1.6.0

getApplicationStructure

public ApplicationStructure getApplicationStructure()

Returns the current application structure.

getFileExtension

public FileExtension getFileExtension()
                               throws HmfhException

Returns the list of file extensions available for import.

Throws:

HmfhException

getADSDelimiter

public CSVDelimiter getADSDelimiter()

Returns the delimiter is used in the ADS file.

Since:

1.6.0

setADSDelimiter

public void setADSDelimiter(CSVDelimiter delimiter)

Specifies the delimiter used in the ADS file.

Parameters:

delimiter - the delimiter to use

Since:

1.6.0

getFileName

public String getFileName()

Returns the name of the current file.

getFilePath

public String getFilePath()

Returns the path of the current file.

getImportType

public ImportType getImportType()

Returns the type of the current import.

isDeleteOldLog

public boolean isDeleteOldLog()

isUpdateOrdering

public boolean isUpdateOrdering()

setApplicationStructure

public void setApplicationStructure(ApplicationStructure applicationStructure)

Sets the current application structure.

setDeleteOldLog

public void setDeleteOldLog(boolean deleteOldLog)

Defines whether or not old logs will be deleted; this property is only used when using Hmfh logging.

setFileName

public void setFileName(String fileName)

Sets the name of the current file.

setFilePath

public void setFilePath(String filePath)

Sets the path of the current file.

setImportType

public void setImportType(ImportType importType)

Sets the type of the current import.

setImportType

public void setImportType(String importType)

Specifies the type of the current import from its String value.

setUpdateOrdering

public void setUpdateOrdering(boolean isUpdateOrdering)

Defines whether or not to update the order of dimensions, attributes, etc, when importing.