wt.ixb.handlers.netmarkets
Class DocumentTemplateIXHandler

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

All Implemented Interfaces:

ClassExporter, ClassExporterImporter, ElementImporter

public class DocumentTemplateIXHandler

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	DOC_TEMPLATE_TYPE
private static String	RULE_RESOURCE
private static NMProjectConstants.DocTemplateInfo	tmplTags

Fields inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplate

Fields inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplateGeneral

CONFLICT_RESOURCE

Constructor Summary

DocumentTemplateIXHandler()

Method Summary

private IxbDocument	createNameMappingRule(String autoName)
Object	createObject(IxbElement elem, Importer imp)
static void	exportDocumentTemplate(WTDocument doc, IxbElement elem, Exporter exp)
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 static QueryResult	findDocsByType(WTContainer cont, boolean templates)
static QueryResult	findDocuments(WTContainer cont)
static QueryResult	findDocumentTemplates(WTContainer cont)
private static String	getIdStr(Object obj)
int	getImportPriority() Return the import priority of the object type represented by this import handler.
Object	storeObject(Object obj, IxbElement elem, Importer imp) That is the general template how to store object.

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

RULE_RESOURCE

private static final String RULE_RESOURCE

See Also:

Constant Field Values

_rb

private static final String _rb

See Also:

Constant Field Values

tmplTags

private static final NMProjectConstants.DocTemplateInfo tmplTags

DOC_TEMPLATE_TYPE

private static final String DOC_TEMPLATE_TYPE

See Also:

Constant Field Values

Constructor Detail

DocumentTemplateIXHandler

public DocumentTemplateIXHandler()

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

exportDocumentTemplate

public static void exportDocumentTemplate(WTDocument doc,
                                          IxbElement elem,
                                          Exporter exp)
                                   throws WTException

Throws:

WTException

createObject

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

Specified by:

createObject in class ClassExporterImporterTemplate

Parameters:

elem -

imp -

Returns:

Object

Throws:

WTException

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

findDocumentTemplates

public static final QueryResult findDocumentTemplates(WTContainer cont)
                                               throws WTException

Throws:

WTException

findDocuments

public static final QueryResult findDocuments(WTContainer cont)
                                       throws WTException

Throws:

WTException

findDocsByType

private static final QueryResult findDocsByType(WTContainer cont,
                                                boolean templates)
                                         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

createNameMappingRule

private IxbDocument createNameMappingRule(String autoName)
                                   throws WTException

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

getIdStr

private static String getIdStr(Object obj)
                        throws WTException

Throws:

WTException