wt.step
Class StepHelper

java.lang.Object
  wt.step.StepHelper

public class StepHelper

extends Object

Access to a 'light-weight' StepService supporting STEP import and export functionality. Taken in part from 'Application Development Guide' Section 7-16, Lightweight Services.

Nested Class Summary

static class

StepHelper.Server The server side implementation of all StepHelper methods.

Field Summary

static Object	IMPORT_ALL_FILES A flag to the import process to specify that all files should be imported
private static String	SERVER_CLASS
private static String	VERBOSE_PROP

Constructor Summary

StepHelper()

Method Summary

static void	export(ExportSelection selection) Export a selection of products in STEP format.
static String	getContentFileExtension() Get the extension for the content file generated by the export.
static String	getConversionLog() Get the contents of the schema converter log for the last conversion attempt.
static String[]	getExportSchemaNames() Get a list of Schemas supported when exporting to a STEP file.
static String[]	getImportFileList(WTDocument importHolder) List all associated files in the contained STEP Package file.
static String[]	getImportSchemaNames() Get a list of Schemas supported when importing from a STEP file.
static void	importStepFile(WTDocument stepFilesHolder, String importSchema, ImportScheme versionsImportScheme, String importFolder, String[] importFilesList, ManagedBaseline baseline) Import a STEP file and associated documents.
private static Object	invokeOnServer(String methodName, Class[] argTypes, Object[] args)

Methods inherited from class java.lang.Object

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

Field Detail

IMPORT_ALL_FILES

public static final Object IMPORT_ALL_FILES

A flag to the import process to specify that all files should be imported

See Also:

importStepFile(wt.doc.WTDocument, java.lang.String, wt.step.processor.ImportScheme, java.lang.String, java.lang.String[], wt.vc.baseline.ManagedBaseline)

VERBOSE_PROP

private static final String VERBOSE_PROP

See Also:

Constant Field Values

SERVER_CLASS

private static final String SERVER_CLASS

Constructor Detail

StepHelper

public StepHelper()

Method Detail

getExportSchemaNames

public static String[] getExportSchemaNames()
                                     throws RemoteException,
                                            TransferException

Get a list of Schemas supported when exporting to a STEP file.

Throws:

RemoteException

TransferException

invokeOnServer

private static Object invokeOnServer(String methodName,
                                     Class[] argTypes,
                                     Object[] args)
                              throws TransferException,
                                     RemoteException

Throws:

TransferException

RemoteException

getImportSchemaNames

public static String[] getImportSchemaNames()
                                     throws RemoteException,
                                            TransferException

Get a list of Schemas supported when importing from a STEP file.

Throws:

RemoteException

TransferException

getContentFileExtension

public static String getContentFileExtension()
                                      throws RemoteException,
                                             TransferException

Get the extension for the content file generated by the export.

Throws:

RemoteException

TransferException

export

public static void export(ExportSelection selection)
                   throws RemoteException,
                          TransferException

Export a selection of products in STEP format.

Parameters:

selection - The object which defines the content and constraints on the export.

Throws:

RemoteException

TransferException

importStepFile

public static void importStepFile(WTDocument stepFilesHolder,
                                  String importSchema,
                                  ImportScheme versionsImportScheme,
                                  String importFolder,
                                  String[] importFilesList,
                                  ManagedBaseline baseline)
                           throws RemoteException,
                                  TransferException

Import a STEP file and associated documents.

Parameters:

stepFilesHolder - the document whose content is a step package containing the base STEP file and all associated documents.

importSchema - the name of the Schema to use when importing.

versionsImportScheme - the scheme for handling import of versions.

importFolder - the folder to construct new instances in.

importFilesList - a list of files in the import package, which should be uploaded during the import process.

baseline - an optional baseline (may be null) for the collection of all imported parts and documents.

Throws:

RemoteException

TransferException

See Also:

getImportFileList(wt.doc.WTDocument), IMPORT_ALL_FILES

getImportFileList

public static String[] getImportFileList(WTDocument importHolder)
                                  throws TransferException,
                                         RemoteException

List all associated files in the contained STEP Package file. That is all files that are not directories or the base STEP file.

Throws:

TransferException

RemoteException

getConversionLog

public static String getConversionLog()
                               throws TransferException,
                                      RemoteException

Get the contents of the schema converter log for the last conversion attempt.

Throws:

TransferException

RemoteException