com.spss.psapi.core

Class FileFormat



  • public final class FileFormat
    extends Enum
    This class defines constants for the different file formats supported by objects in the Modeler API.
    Since:
    PSAPI 1.2
    Version:
    1.0
    Author:
    Julian Clinton
    • Field Detail

      • PROCESSOR_STREAM

        public static final FileFormat PROCESSOR_STREAM
        Identifier for the native ProcessorStream format.
      • DOCUMENT_OUTPUT

        public static final FileFormat DOCUMENT_OUTPUT
        Identifier for the native DocumentOutput format.
      • MODEL_OUTPUT

        public static final FileFormat MODEL_OUTPUT
        Identifier for the native ModelOutput format.
      • PROJECT

        public static final FileFormat PROJECT
        Identifier for the native Project format.
      • PROCESSOR

        public static final FileFormat PROCESSOR
        Identifier for the native Processor format.
      • COMPOSITE_PROCESSOR

        public static final FileFormat COMPOSITE_PROCESSOR
        Identifier for the native CompositeProcessor format.
      • MODEL_OUTPUT_SET

        public static final FileFormat MODEL_OUTPUT_SET
        Identifier for the native ModelOutput set format.
      • STATE

        public static final FileFormat STATE
        Identifier for the native combined ModelOutput and ProcessorStream format.
      • PUBLISHED_IMAGE

        public static final FileFormat PUBLISHED_IMAGE
        Identifier for the native image format produced by a Publisher node.
      • PUBLISHED_PARAMETERS

        public static final FileFormat PUBLISHED_PARAMETERS
        Identifier for the native image parameter format produced by a Publisher node.
      • EXTERNAL_MODULE_SPECIFICATION

        public static final FileFormat EXTERNAL_MODULE_SPECIFICATION
        Identifier for the native external module specification format.
      • HTMLC

        public static final FileFormat HTMLC
        Identifier for HTMLC format.
      • UNKNOWN

        public static final FileFormat UNKNOWN
        Identifier for an unknown file format.
      • COMMA_DELIMITED

        public static final FileFormat COMMA_DELIMITED
        Identifier for comma-delimited text.
      • TAB_DELIMITED

        public static final FileFormat TAB_DELIMITED
        Identifier for tab-delimited text.
      • JPEG

        public static final FileFormat JPEG
        Identifier for JPEG image format.
      • PNG

        public static final FileFormat PNG
        Identifier for PNG image format.
      • BITMAP

        public static final FileFormat BITMAP
        Identifier for bitmap image format.
      • HTML

        public static final FileFormat HTML
        Identifier for HTML format.
      • PLAIN_TEXT

        public static final FileFormat PLAIN_TEXT
        Identifier for plain text format.
      • XML

        public static final FileFormat XML
        Identifier for XML format.
      • RTF

        public static final FileFormat RTF
        Identifier for Rich Text Format.
      • MS_WORD

        public static final FileFormat MS_WORD
        Identifier for MS Word format.
      • MS_EXCEL

        public static final FileFormat MS_EXCEL
        Identifier for MS Excel format.
      • MS_POWERPOINT

        public static final FileFormat MS_POWERPOINT
        Identifier for MS PowerPoint format.
      • ZIP

        public static final FileFormat ZIP
        Identifier for Zip (compressed archive) format.
      • JAR

        public static final FileFormat JAR
        Identifier for JAR (Java archive) format.
      • VIZML

        public static final FileFormat VIZML
        Identifier for VIZML format.
        Since:
        PSAPI 2.0
      • SPSS_DATA

        public static final FileFormat SPSS_DATA
        Identifier for SPSS .sav data format.
        Since:
        PSAPI 11.1
      • SPSS_SCENARIO

        public static final FileFormat SPSS_SCENARIO
        Identifier for SPSS scenario format.
        Since:
        PSAPI 11.1
      • SPSS_SCENARIO_TEMPLATE

        public static final FileFormat SPSS_SCENARIO_TEMPLATE
        Identifier for SPSS scenario template format.
        Since:
        PSAPI 11.1
      • SPSS_APPLICATION_VIEW

        public static final FileFormat SPSS_APPLICATION_VIEW
        Identifier for SPSS application view format.
        Since:
        PSAPI 11.1
      • SPSS_DATA_PROVIDER

        public static final FileFormat SPSS_DATA_PROVIDER
        Identifier for SPSS data provider format.
        Since:
        PSAPI 11.1
      • VIZ

        public static final FileFormat VIZ
        Identifier for VIZ format.
      • SPV

        public static final FileFormat SPV
        Identifier for SPV format.
      • PASW_RULE

        public static final FileFormat PASW_RULE
        Identifier for PASW RULE format.
        Since:
        PSAPI 13.0
      • SPW

        public static final FileFormat SPW
        Identifier for SPW format.
      • MS_WORD2007

        public static final FileFormat MS_WORD2007
        Identifier for MS Word 2007 format.
      • MS_EXCEL2007

        public static final FileFormat MS_EXCEL2007
        Identifier for MS Excel 2007 format.
      • MS_POWERPOINT2007

        public static final FileFormat MS_POWERPOINT2007
        Identifier for MS PowerPoint format.
      • TIFF

        public static final FileFormat TIFF
        Identifier for TIFF format.
      • PDF

        public static final FileFormat PDF
        Identifier for PDF format.
      • EMF

        public static final FileFormat EMF
        Identifier for Enhanced Metafile format.
      • EPS

        public static final FileFormat EPS
        Identifier for Encapsulated PostScript format.
      • MS_EXCEL2007_M

        public static final FileFormat MS_EXCEL2007_M
        Identifier for MS Excel 2007 macro-enabled format.
      • SPSS_WEB_REPORT

        public static final FileFormat SPSS_WEB_REPORT
        Identifier for SPSS Web Report format.
      • COGNOS_ACTIVE_REPORT

        public static final FileFormat COGNOS_ACTIVE_REPORT
        Identifier for Cognos Active Report format.
    • Method Detail

      • equals

        public boolean equals(java.lang.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.
        Overrides:
        equals in class Enum
        Parameters:
        object -
        Returns:
        true if the supplied object is equal to this
      • getMIMEType

        public java.lang.String getMIMEType()
        Returns the MIME type associated with this file format or an empty string if no MIME type has been defined.
        Returns:
        the associated MIME type or an empty string
      • getExtensionCount

        public int getExtensionCount()
        Returns the number of file extensions associated with this file format.
        Returns:
        the number of file extensions
      • getExtensionAt

        public java.lang.String getExtensionAt(int 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 ".".
        Parameters:
        index - the file extension index
        Returns:
        the file extension at the supplied index
      • getDefaultExtension

        public java.lang.String getDefaultExtension()
        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 ".".
        Returns:
        the default file extension or an empty string
      • isValidExtension

        public boolean isValidExtension(java.lang.String extension)
        Returns true if the supplied extension is valid for this file format or false otherwise. null values and the empty string always return false.
        Parameters:
        extension - the file extension
        Returns:
        true if the supplied extension is valid for this file format
      • getFileFilterPattern

        public java.lang.String getFileFilterPattern()
        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.
        Returns:
        a file filter pattern
      • getEnum

        public static FileFormat getEnum(java.lang.String name)
        Returns the enumeration with the supplied name or null if no enumeration exists for the supplied name. The lookup is not case-sensitive.
        Parameters:
        name - the enumeration name
        Returns:
        the enumeration with the supplied name or null
      • getValues

        public static FileFormat[] getValues()
        Returns an array containing all the valid values for this enumeration class.
        Returns:
        an array containing all the valid values for this enumeration class
      • getFileFormatForExtension

        public static FileFormat getFileFormatForExtension(java.lang.String extension)
        Returns the default file format for the supplied extension or null if no matching file format can be found. The extension search is not case-sensitive.
        Parameters:
        extension - the file extension
        Returns:
        the default file format for the supplied extension or null
      • getFileFormatsForExtension

        public static java.util.List getFileFormatsForExtension(java.lang.String extension)
        Returns a list of all file formats with the supplied extension. The extension search is not case-sensitive.
        Parameters:
        extension - the file extension
        Returns:
        a list of file formats for the supplied extension
        Since:
        PSAPI 11.1
      • getFileFormatForMIMEType

        public static FileFormat getFileFormatForMIMEType(java.lang.String mimeType)
        Returns the file format for the supplied MIME type or null if no matching file format can be found.
        Parameters:
        mimeType - the mime type to be searched for
        Returns:
        the file format for the supplied MIME type or null
      • isUnknown

        public boolean isUnknown()
        Returns true if this value is UNKNOWN.
        Overrides:
        isUnknown in class Enum
        Returns:
        true if this represents the unknown FileFormat

(C) Copyright IBM Corp. 1994, 2015. All Rights Reserved.