javax.datamining.task
Interface ImportSummary

public interface ImportSummary

ImportSummary provides information on objects imported by a DME. The objects to be imported are not readily known to the user and the summary provides necessary object information that helps avoid conflicts in object names and types.

The objects that are returned from the methods in this interface are indexed in the same order, and all arrays must contain the same number of elements. For example, if the method getObjectNames returns an array of size 4, then the method getObjectTypes also returns an array of size 4. In addition, the type of the object with the name at index 0 in the array returned from the former can be found at the same location in the array returned from the latter.

All objects in the same import object must have the same format.

Author:

JSR-73 Java Data Mining Expert Group

Method Summary

java.util.Date[]	getCreationDates() Returns an array of creation dates of the object(s) to be imported.
ImportExportFormat	getFormat() Returns the format of the import object.
java.lang.String[]	getObjectClassNames() Returns an array of corresponding JDM class names for the objects in the import object.
int	getObjectCount() Returns the number of named objects imported.
java.lang.String[]	getObjectDescriptions() Returns an array of descriptions for the objects in the import object.
java.lang.String[]	getObjectNames() Returns an array of the names of the objects imported.
NamedObject[]	getObjectTypes() Returns an array of object types in the import object.

Method Detail

getCreationDates

public java.util.Date[] getCreationDates()

Returns an array of creation dates of the object(s) to be imported. The creation date may not be available.

Returns:

Date[]

getFormat

public ImportExportFormat getFormat()

Returns the format of the import object.

Returns:

ImportExportFormat

getObjectClassNames

public java.lang.String[] getObjectClassNames()

Returns an array of corresponding JDM class names for the objects in the import object. The array may be empty. The information on the corresponding object for each class name can be obtained from the array returned by other methods by using the same index.

Returns:

String[]

getObjectCount

public int getObjectCount()

Returns the number of named objects imported. The returned number must be a non-negative integer, as no objects may have been imported due to errors.

Returns:

int

getObjectDescriptions

public java.lang.String[] getObjectDescriptions()

Returns an array of descriptions for the objects in the import object. The array may be empty. The information on the corresponding object for each description can be obtained from the array returned by other methods by using the same index.

Returns:

String[]

getObjectNames

public java.lang.String[] getObjectNames()

Returns an array of the names of the objects imported. The array may be empty. The information on the corresponding object for each name can be obtained from the array returned by other methods by using the same index.

Returns:

String[]

getObjectTypes

public NamedObject[] getObjectTypes()

Returns an array of object types in the import object. The array must contain at least one object type. The information on the corresponding object for each type can be obtained from the array returned by other methods by using the same index.

Returns:

NamedObject[]