com.luciad.lucy.model

LuciadLightspeedClass TLcyFilterFileTypeDescriptor

java.lang.Object

com.luciad.lucy.model.ALcyFileTypeDescriptor

com.luciad.lucy.model.TLcyFilterFileTypeDescriptor

public class TLcyFilterFileTypeDescriptor
extends ALcyFileTypeDescriptor

Implementation of ALcyFileTypeDescriptor that allows a list of valid filters (*.ext or prefix*). A filename is accepted if the filter applies, and the displayname is appended with the filter list (*.ext1, *.ext2, ... )

Constructor Summary

Constructors

Constructor and Description
TLcyFilterFileTypeDescriptor(String aDisplayName, String[] aFilters, String aDefaultExtension) Creates a new TLcyFilterFileTypeDescriptor with the given display name, filters and default extension.

Method Summary

Modifier and Type	Method and Description
String	getDefaultExtension() Returns the default extension of this FileTypeDescriptor.
String	getDisplayName() Returns the previously set display name appended with the filter list (*.ext1, prefix2*, *.ext2, prefix1*, ...
boolean	includes(String aFileName) Returns true if the given filename applies to one of the filters.

Methods inherited from class com.luciad.lucy.model.ALcyFileTypeDescriptor

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcyFilterFileTypeDescriptor

public TLcyFilterFileTypeDescriptor(String aDisplayName,
                                    String[] aFilters,
                                    String aDefaultExtension)

Creates a new TLcyFilterFileTypeDescriptor with the given display name, filters and default extension.

Parameters:

aDisplayName - The display name for this descriptor.

aFilters - The list of valid filters, example (*.ext or prefix*)

aDefaultExtension - The default extension. The extension does not include the dot (.)

Method Detail

getDisplayName

public String getDisplayName()

Returns the previously set display name appended with the filter list (*.ext1, prefix2*, *.ext2, prefix1*, ... ).

Specified by:

getDisplayName in class ALcyFileTypeDescriptor

Returns:

The display name appended with the known filters.

getDefaultExtension

public String getDefaultExtension()

Returns the default extension of this FileTypeDescriptor.

Specified by:

getDefaultExtension in class ALcyFileTypeDescriptor

Returns:

the default extension of this FileTypeDescriptor.

includes

public boolean includes(String aFileName)

Returns true if the given filename applies to one of the filters.

Specified by:

includes in class ALcyFileTypeDescriptor

Parameters:

aFileName - The filename to test.

Returns:

True if the filename is correct, false otherwise.