com.orchestranetworks.service
Class ImportSpec

java.lang.Object
  com.orchestranetworks.service.ImportSpec

public class ImportSpec

extends Object

Defines the features of an import.

For being valid, an instance of this class must at least define a XML source and a target adaptation.

See Also:

ProcedureContext.doImport(ImportSpec)

Constructor Summary

ImportSpec()

Method Summary

ImportSpecMode	getImportMode() Returns the import mode.
File	getSourceFile()
InputStream	getSourceStream()
Adaptation	getTargetAdaptation()
void	setImportMode(ImportSpecMode mode) Specifies the import mode : 'insert', 'insert or update', 'update only'.
void	setSourceFile(File aSource) Specifies the XML document that serves as the source of the import.
void	setSourceStream(InputStream aSource) Specifies that the import process must read the document from the stream specified.
void	setTargetAdaptation(Adaptation aTarget) Specifies the target of the import (mandatory property).
String	toString()
String	toStringInfo() Returns information about the main attributes of this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportSpec

public ImportSpec()

Method Detail

getTargetAdaptation

public Adaptation getTargetAdaptation()

See Also:

setTargetAdaptation(Adaptation)

setTargetAdaptation

public void setTargetAdaptation(Adaptation aTarget)

Specifies the target of the import (mandatory property).

Parameters:

aTarget - the adaptation that will be updated with the imported XML content.

getSourceFile

public File getSourceFile()

See Also:

setSourceFile(File)

setSourceFile

public void setSourceFile(File aSource)

Specifies the XML document that serves as the source of the import.

Parameters:

aSource - the XML document to import.

getSourceStream

public InputStream getSourceStream()

See Also:

setSourceStream(InputStream)

setSourceStream

public void setSourceStream(InputStream aSource)

Specifies that the import process must read the document from the stream specified.

The source stream is a more general alternative than the source file.

It is up to the caller of this method to provide a buffered input stream (if needed for performance).

Parameters:

aSource - the stream containing the XML content to import.

toStringInfo

public String toStringInfo()

Returns information about the main attributes of this instance.

toString

public String toString()

getImportMode

public ImportSpecMode getImportMode()

Returns the import mode.

See Also:

setImportMode(ImportSpecMode)

setImportMode

public void setImportMode(ImportSpecMode mode)

Specifies the import mode : 'insert', 'insert or update', 'update only'.

If not specified, the 'insert' mode is used.