wt.ixb.pdx
Class ExportPackageForPDX

java.lang.Object
  wt.ixb.objectset.ExportPackage
      wt.ixb.pdx.ExportPackageForPDX

public class ExportPackageForPDX

extends ExportPackage

Holds additional information specific for export in PDX format, such as name, description and identifiers of seed objects (i.e. objects used as seeds when generating the export package)

Field Summary

private String	m_description
private String	m_exporterName
private String	m_name
private Set	m_seeds

Fields inherited from class wt.ixb.objectset.ExportPackage

m_objects

Constructor Summary

ExportPackageForPDX(Set seedObjIds, WTHashSet objects, String name, String descr, String exporter)
Fully qualified constructor

Method Summary

static ExportPackage	createExportPackageForPDX(String name, String description, String exporter, String[] generIds, String[] generParams) Convenience method for the common case when objects are collected without filtering
static ExportPackage	createExportPackageForPDX(String name, String description, String exporter, String[] generIds, String[] generParams, String[] filterIds, String[] filterParams) Creates ExportPackage holding all information necessary for export in PDX format.
String	getDescription()
String	getExporterName()
String	getName()
boolean	objectIsSeed(String oid)

Methods inherited from class wt.ixb.objectset.ExportPackage

addAll, addObject, checkParameters, createExportPackage, createExportPackage, getManifest, getObjects, PP, removeAll, removeObject, size

Methods inherited from class java.lang.Object

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

Field Detail

m_name

private String m_name

m_description

private String m_description

m_exporterName

private String m_exporterName

m_seeds

private Set m_seeds

Constructor Detail

ExportPackageForPDX

public ExportPackageForPDX(Set seedObjIds,
                           WTHashSet objects,
                           String name,
                           String descr,
                           String exporter)

Fully qualified constructor

Method Detail

createExportPackageForPDX

public static ExportPackage createExportPackageForPDX(String name,
                                                      String description,
                                                      String exporter,
                                                      String[] generIds,
                                                      String[] generParams,
                                                      String[] filterIds,
                                                      String[] filterParams)
                                               throws WTException

Creates ExportPackage holding all information necessary for export in PDX format. The objects are collected using standard ixb collection mechanism (generators and filters).

Parameters:

name - of the export package

description - description of the export package

exporter - name of the user who makes export

generIds - array of String id for object set generator types, e.g. {"singleDocument", "productStructureNavigatorWithEPM"}

generParams - array of local id for the corresponding seed objects, e.g. {"wt.doc.WTDocument:2059", "wt.part.WTPart:125452"}

filterIds - array of String id for object set filters

filterParams - array of Strings representing parameters for filtering

Throws:

WTException

createExportPackageForPDX

public static ExportPackage createExportPackageForPDX(String name,
                                                      String description,
                                                      String exporter,
                                                      String[] generIds,
                                                      String[] generParams)
                                               throws WTException

Convenience method for the common case when objects are collected without filtering

Parameters:

name - of the export package

description - description of the export package

exporter - name of the user who makes export

generIds - array of String id for object set generator types, e.g. {"singleDocument", "productStructureNavigatorWithEPM"}

generParams - array of local id for the corresponding seed objects, e.g. {"wt.doc.WTDocument:2059", "wt.part.WTPart:125452"}

Throws:

WTException

getName

public String getName()

getDescription

public String getDescription()

getExporterName

public String getExporterName()

objectIsSeed

public boolean objectIsSeed(String oid)

Parameters:

oid - object local id. It has the form , like wt.part.WTPart:1234

Returns:

true if the object is one of the seed objects for this package