Package wt.ixb.publicforapps

Class ApplicationExportHandlerForXml

java.lang.Object

wt.ixb.publicforapps.ApplicationExportHandlerTemplate

wt.ixb.publicforapps.ApplicationExportHandlerForXml

All Implemented Interfaces:

ApplicationExpImportHandler, ApplicationExportHandler

public class ApplicationExportHandlerForXml
extends ApplicationExportHandlerTemplate

This class provides methods for storing XML with JAXB object and content files in export jar file. It handles both ApplicationData content and content residing in local file system.

Supported API: true

Extendable: false

Constructor Summary

Constructors

Constructor	Description
ApplicationExportHandlerForXml(File fileToSave, File dirToSave)	Supported API: true

Method Summary

Modifier and Type	Method	Description
void	addObjectToManifest(String userObjImage)	Adds to manifest's object list Supported API: true
void	createManifest()	Create the manifest file in the jar.
void	createManifest(File manifestFile, String fileName)	Create the manifest file in the jar.
void	finalizeExport(boolean outcome)	do finalize actions before export is finished, current only call cleanTempDir
File	getJarFile()	Gets the value of the attribute: jarFile; The jar file to store exportedinformation (meta data and content data) Supported API: true
Collection<String>	getObjectListForManifest()	Returns the id of Objects exported.
protected File	getSaveDir()	Gets the value of the attribute: saveDir; Directory where the jar file will be stored.
String	storeContent(File file)	Stores content files residing in the local file system (as in the case of Representation objects).
String	storeContent(File file, String filename)	Stores content files residing in the local file system (as in the case of Representation objects).
String	storeContent(Object contentAttr)	Stores the given content of exported object.
String	storeDocument(IxbElement elem)	Stores the given XML element, which is the XML representation of exported object, based on format type for export.
String	storeDocument(IxbElement doc, String schema)	Stores the given XML element, which is the XML representation of exported object, based on the provided DTD.
void	storeLogMessage(String resourceBundle, String messageKey, Object[] textInserts)	Supplies the localized log message for the application.
void	storeLogMessage(String resourceBundle, String messageKey, Object[] textInserts, int importanceLevel)	Supplies the localized log message for the application.

Methods inherited from class wt.ixb.publicforapps.ApplicationExportHandlerTemplate

getCurrentExportContentSize, getIXApplicationContext, getOutputs, getRequiredExportSize, getTargetVersion, initialize, isMultithreadedExportApplicable, reallyStoreContent, setIXApplicationContext, setTargetVersion, storeDocument

Methods inherited from class java.lang.Object

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

Constructor Details

ApplicationExportHandlerForXml

public ApplicationExportHandlerForXml(File fileToSave,
 File dirToSave)
                               throws WTException

Supported API: true

Parameters:

fileToSave - The jar file to store exportedinformation (meta data and content data)

dirToSave - Directory where the jar file will be stored.

Throws:

WTException

Method Details

finalizeExport

public void finalizeExport(boolean outcome)
                    throws WTException

do finalize actions before export is finished, current only call cleanTempDir

Overrides:

finalizeExport in class ApplicationExportHandlerTemplate

Parameters:

outcome -

Supported API: true *

Throws:

WTException

getJarFile

public File getJarFile()

Gets the value of the attribute: jarFile; The jar file to store exportedinformation (meta data and content data)

Supported API: true

Overrides:

getJarFile in class ApplicationExportHandlerTemplate

Returns:

File

getSaveDir

protected File getSaveDir()

Gets the value of the attribute: saveDir; Directory where the jar file will be stored.

Supported API: true

Returns:

File

createManifest

public void createManifest()
                    throws WTException

Create the manifest file in the jar. The content of the manifest file will copy the information as accumulated by calling the method addObjectToManifest (String userObjImage).

Supported API: true *

Throws:

WTException

createManifest

public void createManifest(File manifestFile,
 String fileName)
                    throws WTException

Create the manifest file in the jar. The manifest file will copy the contents in the File file.

Supported API: true *

Overrides:

createManifest in class ApplicationExportHandlerTemplate

Throws:

WTException

storeDocument

public String storeDocument(IxbElement elem)
                     throws WTException

Stores the given XML element, which is the XML representation of exported object, based on format type for export. Return XML file name or some other string identifier for the stored element.

Supported API: true

Specified by:

storeDocument in interface ApplicationExportHandler

Overrides:

storeDocument in class ApplicationExportHandlerTemplate

Parameters:

elem -

Returns:

String

Throws:

WTException

See Also:

• storeDocument (IxbElement elem, String dtd)

storeDocument

public String storeDocument(IxbElement doc,
 String schema)
                     throws WTException

Stores the given XML element, which is the XML representation of exported object, based on the provided DTD. If parameter dtd is null, Windchill's default DTD is assumed. Return XML file name or some other string identifier for the stored element.

Supported API: true

Specified by:

storeDocument in interface ApplicationExportHandler

Overrides:

storeDocument in class ApplicationExportHandlerTemplate

Parameters:

elem -

schema -

Returns:

String

Throws:

WTException

See Also:

• storeDocument (IxbElement elem)

storeContent

public String storeContent(Object contentAttr)
                    throws WTException

Stores the given content of exported object. The return value is String, that will be used in XML file as an identifier of this content. Application should be able to find the content during the import process by this identifier. The content of the associated object might not be saved, depending on the implementation of the this interface.

Supported API: true

Specified by:

storeContent in interface ApplicationExportHandler

Overrides:

storeContent in class ApplicationExportHandlerTemplate

Parameters:

contentAttr - The content attribute which is related to InputStream or BLOB. e.g. it can be ApplicationData , File or String (full path of a file), etc

Returns:

String

Throws:

WTException

storeContent

public String storeContent(File file)
                    throws WTException

Stores content files residing in the local file system (as in the case of Representation objects).

Supported API: true

Specified by:

storeContent in interface ApplicationExportHandler

Overrides:

storeContent in class ApplicationExportHandlerTemplate

Parameters:

file -

Returns:

String

Throws:

WTException

storeContent

public String storeContent(File file,
 String filename)
                    throws WTException

Stores content files residing in the local file system (as in the case of Representation objects).

Supported API: true

Specified by:

storeContent in interface ApplicationExportHandler

Overrides:

storeContent in class ApplicationExportHandlerTemplate

Parameters:

file -

filename -

Returns:

String

Throws:

WTException

storeLogMessage

public void storeLogMessage(String resourceBundle,
 String messageKey,
 Object[] textInserts)
                     throws WTException

Supplies the localized log message for the application.

Supported API: true

Overrides:

storeLogMessage in class ApplicationExportHandlerTemplate

Parameters:

resourceBundle -

messageKey -

textInserts -

Throws:

WTException

storeLogMessage

public void storeLogMessage(String resourceBundle,
 String messageKey,
 Object[] textInserts,
 int importanceLevel)
                     throws WTException

Supplies the localized log message for the application.

Supported API: true

Specified by:

storeLogMessage in interface ApplicationExpImportHandler

Overrides:

storeLogMessage in class ApplicationExportHandlerTemplate

Parameters:

resourceBundle -

messageKey -

textInserts -

importanceLevel -

Throws:

WTException

getObjectListForManifest

public Collection<String> getObjectListForManifest()
                                            throws WTException

Returns the id of Objects exported.

Supported API: true

Overrides:

getObjectListForManifest in class ApplicationExportHandlerTemplate

Returns:

Collection of object id which have been exported.

Throws:

WTException

addObjectToManifest

public void addObjectToManifest(String userObjImage)

Adds to manifest's object list

Supported API: true

Overrides:

addObjectToManifest in class ApplicationExportHandlerTemplate

Parameters:

userObjImage -