javax.datamining.task
Interface ExportTask

All Superinterfaces:

MiningObject, Task

public interface ExportTask

extends Task

An ExportTask provides an abstraction of the metadata needed to convert a JDM object to another format and place it in the specified location. Specified objects must be exportable, but a vendor may choose to export any objects. Exportable objects include: models, build settings (including algorithm settings if contained), tasks, logical data, taxonomy, and results.

The URI specified must be accessible from the DME. Any login information can be obtained from the connection, e.g. to leverage single-sign-on capability.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

MiningObject, Task

Method Summary

void	addObjectName(java.lang.String name, NamedObject namedObjectType) Adds the name of an object to be exported.
ImportExportFormat	getFormat() Returns the format to be used for export.
SettingsInclusionOption	getIncludeModelSettings() Returns the option of whether to include the settings objects contained in a model.
java.lang.String[]	getObjectNames() Returns the names of the objects to be exported.
java.lang.String	getURI() Returns the destination URI where the exported objecs are to be placed.
void	removeObjectName(java.lang.String name, NamedObject namedObjectType) Removes the name of an object to be exported.
void	setFormat(ImportExportFormat format) Sets the format to be used for export.
void	setIncludeModelSettings(SettingsInclusionOption option) Sets the option of whether to include the settings objects contained in any models named.
void	setURI(java.lang.String uri) Sets the destination URI where the exported objecs are to be placed.
VerificationReport	verify() Determines whether the specification of the export task is correct.

Methods inherited from interface javax.datamining.base.Task

getExecutionHandle

Methods inherited from interface javax.datamining.MiningObject

getCreationDate, getCreatorInfo, getDescription, getName, getObjectIdentifier, getObjectType, setDescription

Method Detail

addObjectName

public void addObjectName(java.lang.String name,
                          NamedObject namedObjectType)
                   throws JDMException

Adds the name of an object to be exported. The names must be unique within the NamedObjectType.

Parameters:

name - The name of the object to be added for export.

namedObjectType - The type of the object to be added.

Returns:

void

Throws:

JDMException

getFormat

public ImportExportFormat getFormat()

Returns the format to be used for export.

Returns:

ImportExportFormat

getIncludeModelSettings

public SettingsInclusionOption getIncludeModelSettings()

Returns the option of whether to include the settings objects contained in a model.

Returns:

SettingsInclusionOption

getObjectNames

public java.lang.String[] getObjectNames()

Returns the names of the objects to be exported.

Returns:

String[]

getURI

public java.lang.String getURI()

Returns the destination URI where the exported objecs are to be placed.

Returns:

String

removeObjectName

public void removeObjectName(java.lang.String name,
                             NamedObject namedObjectType)
                      throws JDMException

Removes the name of an object to be exported. An exception is thrown if string length exceeds the maximum name length.

Parameters:

name - The name of the object to be removed for export.

namedObjectType - The type of the object to be removed from export.

Returns:

void

Throws:

JDMException

setFormat

public void setFormat(ImportExportFormat format)

Sets the format to be used for export.

Parameters:

format - An export format to be used.

Returns:

void

setIncludeModelSettings

public void setIncludeModelSettings(SettingsInclusionOption option)

Sets the option of whether to include the settings objects contained in any models named. If the model does not contain settings, e.g., PMML model that was mported without settings, then the setIncludeModelSettings option is ignored.

Parameters:

option - An option for inclusion of the settings objects in a model.

Returns:

void

setURI

public void setURI(java.lang.String uri)
            throws JDMException

Sets the destination URI where the exported objecs are to be placed.

Parameters:

uri - The URI where exported objects are to be placed.

Returns:

void

Throws:

JDMException

verify

public VerificationReport verify()

Determines whether the specification of the export task is correct. This includes a check if all objects exist, the URI is accessible, and the objects can be exported in the format requested.

Returns null if the specification is correct. Returns a VerificationReport otherwise that contains the explanation.

Returns:

VerificationReport