FileFormat Objects

Subclass of Enum.

This class defines constants for the different file formats supported by objects in the Modeler API.

Constants:

BITMAP (FileFormat) : Identifier for bitmap image format.

COGNOS_ACTIVE_REPORT (FileFormat) : Identifier for Cognos Active Report format.

COMMA_DELIMITED (FileFormat) : Identifier for comma-delimited text.

COMPOSITE_PROCESSOR (FileFormat) : Identifier for the native SuperNode format.

DOCUMENT_OUTPUT (FileFormat) : Identifier for the native DocumentOutput format.

EMF (FileFormat) : Identifier for Enhanced Metafile format.

EPS (FileFormat) : Identifier for Encapsulated PostScript format.

EXTERNAL_MODULE_SPECIFICATION (FileFormat) : Identifier for the native external module specification format.

HTML (FileFormat) : Identifier for HTML format.

HTMLC (FileFormat) : Identifier for HTMLC format.

JAR (FileFormat) : Identifier for JAR (Java archive) format.

JPEG (FileFormat) : Identifier for JPEG image format.

MODEL_OUTPUT (FileFormat) : Identifier for the native ModelOutput format.

MODEL_OUTPUT_SET (FileFormat) : Identifier for the native ModelOutput set format.

MS_EXCEL (FileFormat) : Identifier for MS Excel format.

MS_EXCEL2007 (FileFormat) : Identifier for MS Excel 2007 format.

MS_EXCEL2007_M (FileFormat) : Identifier for MS Excel 2007 macro-enabled format.

MS_POWERPOINT (FileFormat) : Identifier for MS PowerPoint format.

MS_POWERPOINT2007 (FileFormat) : Identifier for MS PowerPoint 2007 format.

MS_WORD (FileFormat) : Identifier for MS Word format.

MS_WORD2007 (FileFormat) : Identifier for MS Word 2007 format.

PASW_RULE (FileFormat) : Identifier for PASW RULE format.

PDF (FileFormat) : Identifier for PDF format.

PLAIN_TEXT (FileFormat) : Identifier for plain text format.

PNG (FileFormat) : Identifier for PNG image format.

PROCESSOR (FileFormat) : Identifier for the native Node format.

PROCESSOR_STREAM (FileFormat) : Identifier for the native Stream format.

PROJECT (FileFormat) : Identifier for the native Project format.

PUBLISHED_IMAGE (FileFormat) : Identifier for the native image format produced by a Publisher node.

PUBLISHED_PARAMETERS (FileFormat) : Identifier for the native image parameter format produced by a Publisher node.

RTF (FileFormat) : Identifier for Rich Text Format.

SPSS_APPLICATION_VIEW (FileFormat) : Identifier for SPSS application view format.

SPSS_DATA (FileFormat) : Identifier for SPSS .sav data format.

SPSS_DATA_PROVIDER (FileFormat) : Identifier for SPSS data provider format.

SPSS_SCENARIO (FileFormat) : Identifier for SPSS scenario format.

SPSS_SCENARIO_TEMPLATE (FileFormat) : Identifier for SPSS scenario template format.

SPSS_WEB_REPORT (FileFormat) : Identifier for SPSS Web Report format.

SPV (FileFormat) : Identifier for SPV format.

SPW (FileFormat) : Identifier for SPW format.

STATE (FileFormat) : Identifier for the native combined ModelOutput and Stream format.

TAB_DELIMITED (FileFormat) : Identifier for tab-delimited text.

TIFF (FileFormat) : Identifier for TIFF format.

UNKNOWN (FileFormat) : Identifier for an unknown file format.

VIZ (FileFormat) : Identifier for VIZ format.

VIZML (FileFormat) : Identifier for VIZML format.

XML (FileFormat) : Identifier for XML format.

ZIP (FileFormat) : Identifier for Zip (compressed archive) format.

f.equals(object) : boolean

object (Object) :

Returns True if the supplied object is equal to this. Two file formats are considered equal if the names are equal ignoring the case of the name.

f.getDefaultExtension() : string

Returns the default file extension for this file format or an empty string if no file extensions are defined for this file format. The file extension includes the leading ".".

getEnum(name) : FileFormat

name (string) : the enumeration name

Returns the enumeration with the supplied name or None if no enumeration exists for the supplied name. The lookup is not case-sensitive.

f.getExtensionAt(index) : string

index (int) : the file extension index

Returns the file extansion at the supplied index. The first (0'th) extension is assumed to be the default extension. The file extension includes the leading ".".

f.getExtensionCount() : int

Returns the number of file extensions associated with this file format.

f.getFileFilterPattern() : string

Returns a file filter pattern suitable for use with a file chooser dialog that includes all the file extensions associated with this file type. An empty string is returned if no file extensions are defined for this file type.

getFileFormatForExtension(extension) : FileFormat

extension (string) : the file extension

Returns the default file format for the supplied extension or None if no matching file format can be found. The extension search is not case-sensitive.

getFileFormatForMIMEType(mimeType) : FileFormat

mimeType (string) : the mime type to be searched for

Returns the file format for the supplied MIME type or None if no matching file format can be found.

getFileFormatsForExtension(extension) : List

extension (string) : the file extension

Returns a list of all file formats with the supplied extension. The extension search is not case-sensitive.

f.getMIMEType() : string

Returns the MIME type associated with this file format or an empty string if no MIME type has been defined.

getValues() : FileFormat[]

Returns an array containing all the valid values for this enumeration class.

f.isUnknown() : boolean

Returns True if this value is UNKNOWN.

f.isValidExtension(extension) : boolean

extension (string) : the file extension

Returns True if the supplied extension is valid for this file format or False otherwise. None values and the empty string always return False.