wt.ixb.handlers.netmarkets
Class CsvIxHandler

java.lang.Object
  wt.ixb.publicforhandlers.ClassExporterImporterTemplateGeneral
      wt.ixb.publicforhandlers.ClassExporterImporterTemplate
          wt.ixb.handlers.netmarkets.CsvIxHandler

All Implemented Interfaces:

ClassExporter, ClassExporterImporter, ElementImporter

public class CsvIxHandler

extends ClassExporterImporterTemplate

Nested Class Summary

Nested classes inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplate

ClassExporterImporterTemplate.ContentHolderCommitListener

Field Summary

private static String	_rb
private static String	actionInfo
private static String	AMP
private static String	APOS
private static NMProjectConstants.CsvLoadInfo	csvtags
private static String	LT
private static boolean	ONE_TRANSACTION
private static String	QUOT
private static String	SERVICE_NAME

Fields inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplate

Fields inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplateGeneral

CONFLICT_RESOURCE

Constructor Summary

CsvIxHandler()

Method Summary

private boolean	checkStr(String str)
Object	createObject(IxbElement elem, Importer imp) Creates new instance of Windchill object.
private String	decodeVal(String val)
void	exportObject(Object obj, Exporter exp) Exports the specified object in context given by parameter exporter.
Object	findAmongExistingObjects(IxbElement elem, Importer imp) Implements typical way of finding whether object from given XML file exists already in Windchill database.
private String	getClassName(String inputStr)
int	getImportPriority() Return the import priority of the object type represented by this import handler.
private String	getMethodName(String inputStr)
private void	initiateCache()
private Hashtable	populateInputs(IxbElement elem)
private void	processException(Exception e)
private void	removeCache()
Object	storeObject(Object obj, IxbElement elem, Importer imp) That is the general template how to store object.
private String	stripKey(String orig)
private String	substStr(String inStr, String key, String repl)

Methods inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplate

createFileXMLOnExport, exportAttributes, finalizeImportObject, getRootTag, importElement, importObjectAttributes, importObjectAttributesAfterStore, isObjectIgnored, isObjectNew, outputLog, rememberNewObInfo, setObjectIgnored, setObjectIsNew, storeAdditionalInfo, storeElement

Methods inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplateGeneral

checkConflicts, finalizeCheckConflicts, finalizeExport, finalizeImport, getAdditionalImportPriority, getObjectDisplayID, prepareForCheckConflicts, prepareForImport, previewElement

Methods inherited from class java.lang.Object

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

Field Detail

LT

private static final String LT

See Also:

Constant Field Values

AMP

private static final String AMP

See Also:

Constant Field Values

QUOT

private static final String QUOT

See Also:

Constant Field Values

APOS

private static final String APOS

See Also:

Constant Field Values

SERVICE_NAME

private static final String SERVICE_NAME

See Also:

Constant Field Values

_rb

private static final String _rb

See Also:

Constant Field Values

actionInfo

private static final String actionInfo

See Also:

Constant Field Values

csvtags

private static final NMProjectConstants.CsvLoadInfo csvtags

ONE_TRANSACTION

private static boolean ONE_TRANSACTION

Constructor Detail

CsvIxHandler

public CsvIxHandler()

Method Detail

exportObject

public void exportObject(Object obj,
                         Exporter exp)
                  throws WTException

Description copied from class: ClassExporterImporterTemplate

Exports the specified object in context given by parameter exporter.
The implementation of this method is partitioned into several protected methods. Individual class handlers can override the following protected methods:

• createFileXMLOnExport(Exporter exporter), which create an IxbDocument with the root tag. See getRootTag();
• exportAttributes (Object object, IxbElement fileXML, Exporter exporter) which will export the attributes according to the DTD. The parameter fileXML is the returned vlue from createFileXMLOnExport(Exporter exporter).
• storeElement(Object object, IxbElement fileXML, Exporter exporter) which will store the fileXML into an xml-file.

Also, export actions from either client or system registry will be performed. Specifically, the two methods wt.ixb.tuner.ExportActionHelper.performPreExportAction () and wt.ixb.tuner.ExportActionHelper.performPostExportAction () will be called before and after th above three protected methods, respectively.

Supported API: true

Specified by:

exportObject in interface ClassExporter

Overrides:

exportObject in class ClassExporterImporterTemplate

Parameters:

obj -

exp - The Exporter instance that represents the context of the export operation.

Throws:

WTException

createObject

public Object createObject(IxbElement elem,
                           Importer imp)
                    throws WTException

Description copied from class: ClassExporterImporterTemplate

Creates new instance of Windchill object. Every class requires its own method to create object of this class. So, this method must be overriden by any class specific import handler

Supported API: true

Specified by:

createObject in class ClassExporterImporterTemplate

Parameters:

elem -

imp -

Returns:

Object

Throws:

WTException

processException

private void processException(Exception e)
                       throws WTException

Throws:

WTException

getClassName

private String getClassName(String inputStr)
                     throws WTException

Throws:

WTException

getMethodName

private String getMethodName(String inputStr)
                      throws WTException

Throws:

WTException

checkStr

private boolean checkStr(String str)

populateInputs

private Hashtable populateInputs(IxbElement elem)
                          throws WTException

Throws:

WTException

stripKey

private String stripKey(String orig)

decodeVal

private String decodeVal(String val)

substStr

private String substStr(String inStr,
                        String key,
                        String repl)

getImportPriority

public int getImportPriority()
                      throws WTException

Description copied from class: ClassExporterImporterTemplateGeneral

Return the import priority of the object type represented by this import handler.
Import priority defines the order in which objects will be imported. This method does not carry parameters in the signature. The return value can not be negative. Those XML files will have a higher import priority for smaller returned values.

Supported API: true

Specified by:

getImportPriority in interface ElementImporter

Specified by:

getImportPriority in class ClassExporterImporterTemplateGeneral

Returns:

int

Throws:

WTException

initiateCache

private void initiateCache()
                    throws WTException

Throws:

WTException

removeCache

private void removeCache()
                  throws WTException

Throws:

WTException

findAmongExistingObjects

public Object findAmongExistingObjects(IxbElement elem,
                                       Importer imp)
                                throws WTException

Description copied from class: ClassExporterImporterTemplate

Implements typical way of finding whether object from given XML file exists already in Windchill database.

Supported API: true

Overrides:

findAmongExistingObjects in class ClassExporterImporterTemplate

Parameters:

elem -

imp -

Returns:

Object

Throws:

WTException

storeObject

public Object storeObject(Object obj,
                          IxbElement elem,
                          Importer imp)
                   throws WTException

Description copied from class: ClassExporterImporterTemplate

That is the general template how to store object. It looks like it will be good for many classes. If for some class it is not good then it can be override this method

Supported API: true

Overrides:

storeObject in class ClassExporterImporterTemplate

Parameters:

obj -

elem -

imp -

Returns:

Object

Throws:

WTException