org.eclipse.rse.core.filters
Class SystemFilterNamingPolicy

java.lang.Object
  org.eclipse.rse.core.filters.SystemFilterNamingPolicy

All Implemented Interfaces:

IRSEFilterNamingPolicy, ISystemFilterConstants, ISystemFilterSavePolicies

Direct Known Subclasses:

SubSystemFilterNamingPolicy

public class SystemFilterNamingPolicy

extends Object

implements IRSEFilterNamingPolicy, ISystemFilterConstants

A naming policy so tool writers can override defaults used when saving filter data to disk.

Subclass this and override what you wish to change.

Field Summary

static String	DEFAULT_FILENAME_PREFIX_FILTER Default prefix for filter persisted file: "filter_"
static String	DEFAULT_FILENAME_PREFIX_FILTERPOOL Default prefix for filter pool persisted file: "filterPool_"
static String	DEFAULT_FILENAME_PREFIX_FILTERPOOLMANAGER Default prefix for filter pool manager persisted file: "filterPools_"
static String	DEFAULT_FILENAME_PREFIX_FILTERPOOLREFERENCEMANAGER Default prefix for filter pool reference manager persisted file: "filterPoolRefs_"
static String	DEFAULT_FOLDERNAME_PREFIX_FILTERPOOL Default prefix for filter pool folder: "FilterPool_"
protected String	filterFileNamePrefix
protected String	managerFileNamePrefix
protected String	poolFileNamePrefix
protected String	poolFolderNamePrefix
protected String	poolFolderNameSuffix
protected String	referenceManagerFileNamePrefix

Fields inherited from interface org.eclipse.rse.core.filters.ISystemFilterConstants

DEFAULT_TYPE, SAVEFILE_SUFFIX, TRY_TO_RESTORE_NO, TRY_TO_RESTORE_YES

Fields inherited from interface org.eclipse.rse.core.filters.ISystemFilterSavePolicies

SAVE_POLICY_NONE, SAVE_POLICY_ONE_FILE_PER_FILTER, SAVE_POLICY_ONE_FILE_PER_MANAGER, SAVE_POLICY_ONE_FILE_PER_POOL_SAME_FOLDER, SAVE_POLICY_ONE_FILEANDFOLDER_PER_POOL

Constructor Summary

SystemFilterNamingPolicy()
Constructor for SystemFilterNamingPolicyImpl

Method Summary

String	getFilterPoolFolderName(String poolName) Get the folder name for the given SystemFilterPool object.
String	getFilterPoolFolderNamePrefix() Get the folder name prefix for all pool folders.
String	getFilterPoolSaveFileName(String poolName) Get the unqualified save file name for the given SystemFilterPool object.
String	getFilterPoolSaveFileNamePrefix() Get the file name prefix for all pool files.
String	getFilterSaveFileName(String filterName) Get the unqualified save file name for the given SystemFilter object.
String	getFilterSaveFileNamePrefix() Get the file name prefix for all filter files.
String	getManagerSaveFileName(String managerName) Get the unqualified save file name for the given SystemFilterPoolManager object.
static IRSEFilterNamingPolicy	getNamingPolicy() Factory method to return an instance populated with defaults.
String	getReferenceManagerSaveFileName(String managerName) Get the unqualified save file name for the given SystemFilterPoolReferenceManager object.

Methods inherited from class java.lang.Object

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

Field Detail

managerFileNamePrefix

protected String managerFileNamePrefix

poolFolderNamePrefix

protected String poolFolderNamePrefix

poolFolderNameSuffix

protected String poolFolderNameSuffix

poolFileNamePrefix

protected String poolFileNamePrefix

filterFileNamePrefix

protected String filterFileNamePrefix

referenceManagerFileNamePrefix

protected String referenceManagerFileNamePrefix

DEFAULT_FILENAME_PREFIX_FILTERPOOLMANAGER

public static final String DEFAULT_FILENAME_PREFIX_FILTERPOOLMANAGER

Default prefix for filter pool manager persisted file: "filterPools_"

See Also:

Constant Field Values

DEFAULT_FILENAME_PREFIX_FILTERPOOLREFERENCEMANAGER

public static final String DEFAULT_FILENAME_PREFIX_FILTERPOOLREFERENCEMANAGER

Default prefix for filter pool reference manager persisted file: "filterPoolRefs_"

See Also:

Constant Field Values

DEFAULT_FILENAME_PREFIX_FILTERPOOL

public static final String DEFAULT_FILENAME_PREFIX_FILTERPOOL

Default prefix for filter pool persisted file: "filterPool_"

See Also:

Constant Field Values

DEFAULT_FILENAME_PREFIX_FILTER

public static final String DEFAULT_FILENAME_PREFIX_FILTER

Default prefix for filter persisted file: "filter_"

See Also:

Constant Field Values

DEFAULT_FOLDERNAME_PREFIX_FILTERPOOL

public static final String DEFAULT_FOLDERNAME_PREFIX_FILTERPOOL

Default prefix for filter pool folder: "FilterPool_"

See Also:

Constant Field Values

Constructor Detail

SystemFilterNamingPolicy

public SystemFilterNamingPolicy()

Constructor for SystemFilterNamingPolicyImpl

Method Detail

getNamingPolicy

public static IRSEFilterNamingPolicy getNamingPolicy()

Factory method to return an instance populated with defaults. Can then simply override whatever is desired.

getManagerSaveFileName

public String getManagerSaveFileName(String managerName)

Get the unqualified save file name for the given SystemFilterPoolManager object. Do NOT include the extension, as .xmi will be added.

Returns "filterPools_"+managerName by default.

Specified by:

getManagerSaveFileName in interface IRSEFilterNamingPolicy

getReferenceManagerSaveFileName

public String getReferenceManagerSaveFileName(String managerName)

Get the unqualified save file name for the given SystemFilterPoolReferenceManager object. Do NOT include the extension, as .xmi will be added.

Returns "filterPoolRefs_"+managerName by default.

Specified by:

getReferenceManagerSaveFileName in interface IRSEFilterNamingPolicy

getFilterPoolSaveFileName

public String getFilterPoolSaveFileName(String poolName)

Get the unqualified save file name for the given SystemFilterPool object. Do NOT include the extension, as .xmi will be added.

Returns getFilterPoolSaveFileNamePrefix()+poolName by default.

Specified by:

getFilterPoolSaveFileName in interface IRSEFilterNamingPolicy

getFilterPoolSaveFileNamePrefix

public String getFilterPoolSaveFileNamePrefix()

Get the file name prefix for all pool files. Used to deduce the saved pools by examining the file system

By default returns "filterPool_"

Specified by:

getFilterPoolSaveFileNamePrefix in interface IRSEFilterNamingPolicy

getFilterPoolFolderName

public String getFilterPoolFolderName(String poolName)

Get the folder name for the given SystemFilterPool object.

Returns getFilterPoolFolderNamePrefix()+poolName by default.

Specified by:

getFilterPoolFolderName in interface IRSEFilterNamingPolicy

getFilterPoolFolderNamePrefix

public String getFilterPoolFolderNamePrefix()

Get the folder name prefix for all pool folders. Used to deduce the saved pools by examining the file system

By default returns "FilterPool_"

Specified by:

getFilterPoolFolderNamePrefix in interface IRSEFilterNamingPolicy

getFilterSaveFileName

public String getFilterSaveFileName(String filterName)

Get the unqualified save file name for the given SystemFilter object. Do NOT include the extension, as .xmi will be added.

Returns getFilterSaveFileNamePrefix()+filterName by default.

Specified by:

getFilterSaveFileName in interface IRSEFilterNamingPolicy

getFilterSaveFileNamePrefix

public String getFilterSaveFileNamePrefix()

Get the file name prefix for all filter files. Used to deduce the saved filters by examining the file system

Returns "Filter_" by default.

Specified by:

getFilterSaveFileNamePrefix in interface IRSEFilterNamingPolicy