ext.tools

Class ContentToolbox

Object

ContentToolbox

All Implemented Interfaces:

RemoteAccess

public class ContentToolbox
extends Object
implements RemoteAccess

Field Summary

Fields

Modifier and Type	Field and Description
static DataFormatReference	formatRef
static int	MAJOR
static int	MINOR

Fields inherited from interface RemoteAccess

versionID

Constructor Summary

Constructors

Constructor and Description
ContentToolbox()
ContentToolbox(boolean warn)

Method Summary

Methods

Modifier and Type	Method and Description
void	createTempDir() Creates a temporary directoy under Windchill/temp for use with this ContentToolbox object.
File	createTempDir(File parentDir) Creates a temporary directoy under a given parent dir for use with this ContentToolbox object.
String	createTempDir(String parentDir) Creates a temporary directoy under a given parent dir for use with this ContentToolbox object.
ContentHolder	deleteAllContent(ContentHolder theHolder) Deletes all ContentItems (including Primary) from the ContentHolder.
static void	deleteContent(ContentHolder theHolder, ContentItem theItem) Deletes the specified ContentItem from the ContentHolder.
static void	deletePrimary(FormatContentHolder ch)
static void	deletePrimary(FormatContentHolder ch, boolean resetFormat)
static void	deletePrimary(WTDocument theDoc) Deletes the primary content of a WTDocument.
boolean	deleteTempDir()
boolean	deleteTempDirectory() Deletes the temporary directory associated with this toolbox.
static File	doUncompressFile(String inFileName, String outFileName) Uncompress the incoming file.
File	downloadContent(ApplicationData theItem) Download the specified ContentItem from the ContentHolder to the temp directory and return it as a File.
File	downloadContent(ApplicationData theItem, File location) Download the specified ContentItem from the ContentHolder to the temp directory and return it as a File.
File	downloadContent(ApplicationData theItem, String fn)
File	downloadPrimary(FormatContentHolder theDoc) Downloads and returns the primary content of the WTDocument.
File	downloadPrimary(FormatContentHolder theDoc, String fileName) Downloads and returns the primary content of the WTDocument to the specified file.
File	downloadPrimary(WTDocument theDoc, File location) Downloads and returns the primary content of the WTDocument to the specified location.
static Enumeration	getContents(ContentHolder theHolder) Returns all secondary contents for an object as an Enumeration.
static String	getExtension(String f) Used to extract and return the extension of a given file.
static String	getFileName(String f) Used to extract the filename without its extension.
static InputStream	getIsFromContentHolder(ContentHolder ch, ContentRoleType crt) Method getIsFromContentHolder.
static InputStream	getIsFromContentHolder(ContentHolder ch, String contentName) Method getIsFromContentHolder.
static ContentItem	getPrimary(ContentHolder ch)
File	getTempDir() Returns the currently assigned temporary directory or null if it hasn't been assigned.
String	getTempDirName()
static void	main(String[] args)
void	setTempDir(File theDirectory) Assigns the temporary directory for this toolbox to the specified directory.
static ContentHolder	updateContent(ContentHolder theHolder, File theFile, String filename) Replaces an existing secondary ContentItem with the specified File if it has the same name or creates a new ContentItem if it does not.
static ContentHolder	updateContent(ContentHolder theHolder, File theFile, String filename, String category) Replaces an existing secondary ContentItem with the specified File if it has the same name or creates a new ContentItem if it does not.
static ContentHolder	updateContent(ContentHolder theHolder, String theFile, String filename) Replaces an existing secondary ContentItem with the specified File if it has the same name or creates a new ContentItem if it does not.
static ContentHolder	updateContent(ContentHolder theHolder, String theFile, String filename, String category) Replaces an existing secondary ContentItem with the specified File if it has the same name or creates a new ContentItem if it does not.
static void	updatePrimary(EPMDocument epmdoc, String newAuthoringApp, File theFile, String filename, boolean iterate)
static void	updatePrimary(FormatContentHolder theDoc, File theFile, String filename) Creates or Updates the primary content of a WTDocument using the specified file.
static void	updatePrimary(FormatContentHolder theDoc, File theFile, String filename, boolean iterate)
static void	updatePrimary(FormatContentHolder theDoc, File theFile, String filename, boolean iterate, Map<String,String> updateIBAs)
static void	updatePrimary(FormatContentHolder theDoc, File theFile, String filename, boolean iterate, Map<String,String> updateIBAs, String categoryType)
static void	updatePrimary(FormatContentHolder theDoc, File theFile, String filename, String categoryType)

Methods inherited from class Object

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

Field Detail

MAJOR

public static final int MAJOR

See Also:

Constant Field Values

MINOR

public static final int MINOR

See Also:

Constant Field Values

formatRef

public static final DataFormatReference formatRef

Constructor Detail

ContentToolbox

public ContentToolbox(boolean warn)

ContentToolbox

public ContentToolbox()

Method Detail

createTempDir

public void createTempDir()
                   throws IOException

Creates a temporary directoy under Windchill/temp for use with this ContentToolbox object.

Throws:

IOException - if there is a problem reading WTProperties

createTempDir

public String createTempDir(String parentDir)
                     throws IOException

Creates a temporary directoy under a given parent dir for use with this ContentToolbox object.

Throws:

IOException - if there is a problem

createTempDir

public File createTempDir(File parentDir)
                   throws IOException

Creates a temporary directoy under a given parent dir for use with this ContentToolbox object.

Throws:

IOException - if there is a problem

getTempDir

public File getTempDir()

Returns the currently assigned temporary directory or null if it hasn't been assigned.

Returns:

the current temporary directory.

getTempDirName

public String getTempDirName()

setTempDir

public void setTempDir(File theDirectory)
                throws FileNotFoundException

Assigns the temporary directory for this toolbox to the specified directory.

Parameters:

theDirectory - - existing directory

Throws:

FileNotFoundException

FileNotFoundException - if the directory does not exist

deleteTempDirectory

public boolean deleteTempDirectory()

Deletes the temporary directory associated with this toolbox. If successful returns true. return boolean successful

deleteTempDir

public boolean deleteTempDir()

downloadPrimary

public File downloadPrimary(FormatContentHolder theDoc)
                     throws IOException,
                            WTException,
                            PropertyVetoException

Downloads and returns the primary content of the WTDocument. Will return null if content does not exist. Will overwrite existing file. Uses server side methods.

Parameters:

theDoc - - WTDocument object to download primary content from

Returns:

the File downloaded

Throws:

IOException

WTException

PropertyVetoException

WTException

downloadPrimary

public File downloadPrimary(WTDocument theDoc,
                   File location)
                     throws IOException,
                            WTException,
                            PropertyVetoException

Downloads and returns the primary content of the WTDocument to the specified location. Uses server side methods. Will return null if content does not exist.

Parameters:

theDoc - - WTDocument object to download primary content from

location - - an existing directory to download to

Returns:

the File downloaded

Throws:

IOException

WTException

PropertyVetoException

WTException

downloadPrimary

public File downloadPrimary(FormatContentHolder theDoc,
                   String fileName)
                     throws IOException,
                            WTException,
                            PropertyVetoException

Downloads and returns the primary content of the WTDocument to the specified file. Uses server side methods. Will return null if content does not exist.

Parameters:

theDoc - - WTDocument object to download primary content from

file - - a file (within an existing directory) to download to

Returns:

the File downloaded

Throws:

IOException

WTException

PropertyVetoException

WTException

deletePrimary

public static void deletePrimary(WTDocument theDoc)
                          throws WTException,
                                 PropertyVetoException

Deletes the primary content of a WTDocument. Uses server side methods. Invoke on working copy and checkin to create a new iteration (recommended).

Parameters:

theDoc - - WTDocument object to download primary content from

Throws:

WTException

PropertyVetoException

WTException

deletePrimary

public static void deletePrimary(FormatContentHolder ch)
                          throws WTException,
                                 PropertyVetoException

Throws:

WTException

PropertyVetoException

deletePrimary

public static void deletePrimary(FormatContentHolder ch,
                 boolean resetFormat)
                          throws WTException,
                                 PropertyVetoException

Throws:

WTException

PropertyVetoException

updatePrimary

public static void updatePrimary(FormatContentHolder theDoc,
                 File theFile,
                 String filename)
                          throws WTException,
                                 PropertyVetoException,
                                 ObjectNoLongerExistsException,
                                 FileNotFoundException,
                                 IOException

Creates or Updates the primary content of a WTDocument using the specified file. Uses server side methods. Invoke on working copy and checkin to create a new iteration (recommended).

Parameters:

theDoc - - WTDocument object to download primary content from

theFile - - the new primary content

filename - - the filename to use when creating the content

Throws:

WTException

PropertyVetoException

ObjectNoLongerExistsException

FileNotFoundException

IOException

ObjectNoLongerExistsException

FileNotFoundException

WTException

IOException

updatePrimary

public static void updatePrimary(FormatContentHolder theDoc,
                 File theFile,
                 String filename,
                 String categoryType)
                          throws WTException,
                                 PropertyVetoException,
                                 ObjectNoLongerExistsException,
                                 FileNotFoundException,
                                 IOException

Throws:

WTException

PropertyVetoException

ObjectNoLongerExistsException

FileNotFoundException

IOException

updatePrimary

public static void updatePrimary(FormatContentHolder theDoc,
                 File theFile,
                 String filename,
                 boolean iterate)
                          throws WTException,
                                 PropertyVetoException,
                                 ObjectNoLongerExistsException,
                                 FileNotFoundException,
                                 IOException

Throws:

WTException

PropertyVetoException

ObjectNoLongerExistsException

FileNotFoundException

IOException

updatePrimary

public static void updatePrimary(FormatContentHolder theDoc,
                 File theFile,
                 String filename,
                 boolean iterate,
                 Map<String,String> updateIBAs)
                          throws WTException,
                                 PropertyVetoException,
                                 ObjectNoLongerExistsException,
                                 FileNotFoundException,
                                 IOException

Throws:

WTException

PropertyVetoException

ObjectNoLongerExistsException

FileNotFoundException

IOException

updatePrimary

public static void updatePrimary(FormatContentHolder theDoc,
                 File theFile,
                 String filename,
                 boolean iterate,
                 Map<String,String> updateIBAs,
                 String categoryType)
                          throws WTException,
                                 PropertyVetoException,
                                 ObjectNoLongerExistsException,
                                 FileNotFoundException,
                                 IOException

Throws:

WTException

PropertyVetoException

ObjectNoLongerExistsException

FileNotFoundException

IOException

updatePrimary

public static void updatePrimary(EPMDocument epmdoc,
                 String newAuthoringApp,
                 File theFile,
                 String filename,
                 boolean iterate)
                          throws WTException,
                                 PropertyVetoException,
                                 ObjectNoLongerExistsException,
                                 FileNotFoundException,
                                 IOException,
                                 InvocationTargetException

Throws:

WTException

PropertyVetoException

ObjectNoLongerExistsException

FileNotFoundException

IOException

InvocationTargetException

getContents

public static Enumeration getContents(ContentHolder theHolder)
                               throws WTException,
                                      PropertyVetoException

Returns all secondary contents for an object as an Enumeration. Remember ApplicationData objects are a type of ContentItem that represent a physical file as opposed to a URLData object (also a ContentItem) which represents a URL. Use the statement if (object instanceof wt.content.ApplicationData) to test objects for their type.

Parameters:

theHolder - - any ContentHolder

Returns:

an Enumeration of the secondary conetents

Throws:

WTException

PropertyVetoException

WTException

downloadContent

public File downloadContent(ApplicationData theItem)
                     throws WTException,
                            IOException

Download the specified ContentItem from the ContentHolder to the temp directory and return it as a File.

Parameters:

theItem - - an ApplicationData held by theHolder (remember ApplicationData is a type of ContentItem that represents a file)

Returns:

the File downloaded

Throws:

WTException - if the item can't by found

IOException

downloadContent

public File downloadContent(ApplicationData theItem,
                   String fn)
                     throws WTException,
                            IOException

Throws:

WTException

IOException

downloadContent

public File downloadContent(ApplicationData theItem,
                   File location)
                     throws WTException,
                            FileNotFoundException,
                            IOException

Download the specified ContentItem from the ContentHolder to the temp directory and return it as a File.

Parameters:

theItem - - an ApplicationData held by theHolder (remember ApplicationData is a type of ContentItem that represents a file)

location - - an existing directory to download to

Returns:

the File downloaded

Throws:

WTException - if the item can't by found

FileNotFoundException - if the file doesn't exist

IOException

deleteContent

public static void deleteContent(ContentHolder theHolder,
                 ContentItem theItem)
                          throws WTException,
                                 PropertyVetoException

Deletes the specified ContentItem from the ContentHolder. Uses server side methods. Invoke on working copy and checkin to create a new iteration (recommended).

Parameters:

theHolder - - any ContentHolder

theItem - - a ContentItem held by theHolder

Throws:

WTException - if the item can't by found

PropertyVetoException

deleteAllContent

public ContentHolder deleteAllContent(ContentHolder theHolder)
                               throws WTException,
                                      PropertyVetoException

Deletes all ContentItems (including Primary) from the ContentHolder. Uses server side methods. Invoke on working copy and checkin to create a new iteration (recommended).

Parameters:

theHolder - - any ContentHolder

Returns:

the refreshed ContentHolder

Throws:

WTException - if the item can't by found

PropertyVetoException

updateContent

public static ContentHolder updateContent(ContentHolder theHolder,
                          String theFile,
                          String filename)
                                   throws Exception

Replaces an existing secondary ContentItem with the specified File if it has the same name or creates a new ContentItem if it does not. Uses server side methods. Invoke on working copy and checkin to create a new iteration (recommended).

Parameters:

theHolder - - any ContentHolder

theFile - - theFile on the server to upload

filename - - the filename to use when adding the content

Returns:

the refreshed ContentHolder

Throws:

WTException

PropertyVetoException

FileNotFoundException

IOException

Exception

updateContent

public static ContentHolder updateContent(ContentHolder theHolder,
                          String theFile,
                          String filename,
                          String category)
                                   throws Exception

Replaces an existing secondary ContentItem with the specified File if it has the same name or creates a new ContentItem if it does not. Uses server side methods. Invoke on working copy and checkin to create a new iteration (recommended).

Parameters:

theHolder - - any ContentHolder

theFile - - theFile on the server to upload

filename - - the filename to use when adding the content

filename - - content category from com.ptc.windchill.cadx.editattachments.ContentCategoryRB

Returns:

the refreshed ContentHolder

Throws:

WTException

PropertyVetoException

FileNotFoundException

IOException

Exception

updateContent

public static ContentHolder updateContent(ContentHolder theHolder,
                          File theFile,
                          String filename)
                                   throws WTException,
                                          PropertyVetoException,
                                          FileNotFoundException,
                                          IOException

Replaces an existing secondary ContentItem with the specified File if it has the same name or creates a new ContentItem if it does not. Uses server side methods. Invoke on working copy and checkin to create a new iteration (recommended).

Parameters:

theHolder - - any ContentHolder

theFile - - theFile on the server to upload

filename - - the filename to use when adding the content

Returns:

the refreshed ContentHolder

Throws:

WTException

PropertyVetoException

FileNotFoundException

IOException

updateContent

public static ContentHolder updateContent(ContentHolder theHolder,
                          File theFile,
                          String filename,
                          String category)
                                   throws WTException,
                                          PropertyVetoException,
                                          FileNotFoundException,
                                          IOException

Replaces an existing secondary ContentItem with the specified File if it has the same name or creates a new ContentItem if it does not. Uses server side methods. Invoke on working copy and checkin to create a new iteration (recommended).

Parameters:

theHolder - - any ContentHolder

theFile - - theFile on the server to upload

filename - - the filename to use when adding the content

filename - - application data category

Returns:

the refreshed ContentHolder

Throws:

WTException

PropertyVetoException

FileNotFoundException

IOException

getIsFromContentHolder

public static InputStream getIsFromContentHolder(ContentHolder ch,
                                 ContentRoleType crt)
                                          throws WTException

Method getIsFromContentHolder.

Parameters:

ch - ContentHolder

crt - ContentRoleType

Returns:

InputStream

Throws:

WTException

getIsFromContentHolder

public static InputStream getIsFromContentHolder(ContentHolder ch,
                                 String contentName)
                                          throws WTException

Method getIsFromContentHolder.

Parameters:

ch - ContentHolder

contentName - String

Returns:

InputStream

Throws:

WTException

doUncompressFile

public static File doUncompressFile(String inFileName,
                    String outFileName)

Uncompress the incoming file.

Parameters:

inFileName - Name of the file to be uncompressed

outFileName - New file name, if null old - gz is used

Returns:

File

getExtension

public static String getExtension(String f)

Used to extract and return the extension of a given file.

Parameters:

f - Incoming file to get the extension of

Returns:

String representing the extension of the incoming file.

getFileName

public static String getFileName(String f)

Used to extract the filename without its extension.

Parameters:

f - Incoming file to get the filename

Returns:

String representing the filename without its extension.

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

getPrimary

public static ContentItem getPrimary(ContentHolder ch)
                              throws Exception

Throws:

Exception