Package org.esa.snap.core.dataio

Interface ProductIOPlugIn

    • Method Detail

      • getFormatNames

        String[] getFormatNames()
        Gets the names of the product formats handled by this product I/O plug-in.
        Returns:
        the names of the product formats handled by this product I/O plug-in, never null

      • getDefaultFileExtensions

        String[] getDefaultFileExtensions()
        Gets the default file extensions associated with each of the format names returned by the getFormatNames() method.

        The string array returned shall have the same length as the array returned by the getFormatNames() method.

        The extensions returned in the string array also shall always include a leading colon ('.') character, e.g. ".hdf". If there is no default files extensions an empty array can be returned.

        Returns:
        the default file extensions for this product I/O plug-in, never null

      • getDescription

        String getDescription​(Locale locale)
        Gets a short description of this plug-in. If the given locale is set to null the default locale is used.

        In a GUI, the description returned could be used as tool-tip text.

        Parameters:
        locale - the local for the given description string, if null the default locale is used
        Returns:
        a textual description of this product reader/writer

      • getProductFileFilter

        SnapFileFilter getProductFileFilter()
        Gets an instance of SnapFileFilter for use in a JFileChooser.
        Returns:
        a file filter or null if this plugin doesn't support file filter. If not provided, the reader will not be available in SNAP Desktop.