RSE
Release 3.2

org.eclipse.rse.core
Class SystemRemoteObjectMatcher

java.lang.Object
  extended by org.eclipse.rse.core.SystemRemoteObjectMatcher
Direct Known Subclasses:
SystemRemoteFileMatcher

public class SystemRemoteObjectMatcher
extends Object

This class encapsulates all the criteria required to identify a match on a remote system object, and the methods to determine if a given input meets that criteria.

  1. subsystemconfigurationid. For scoping to remote objects for a given subsystem configuration
  2. subsystemconfigurationCategory. For scoping to remote objects for a given subsystem configuration category.
  3. systemTypes. For scoping to remote objects from systems of a given type, or semicolon-separated types.
  4. category. For scoping to remote objects of a given type category
  5. namefilter. For scoping to remote objects of a given name
  6. typefilter. For scoping to remote objects of a given type
  7. subtypefilter. For scoping to remote objects of a given subtype
  8. subsubtypefilter. For scoping to remote objects of a given sub-subtype

The names given can be scalar or very simple generic (begin or end with an asterisk). Occasionally, as with iSeries objects types, an asterisk is a valid part of the name, as in *PGM. If "*PGM" is specified for the type filter, then it would match on other types too, like *SRVPGM. To solve this special case, users can specify the following to tell us that the asterisk is to be taken literally, versus as a leading or trailing wild card:


  "%%ast.PGM" or "%%ast;PGM"
 

The special symbol "%%ast." is resolved into an asterisk as part of the literal name.

See Also:
ISystemRemoteObjectMatchProvider

Field Summary
static String STAR_SYMBOL
           
static int STAR_SYMBOL_LEN
           
static String STAR_SYMBOL2
           
 
Constructor Summary
SystemRemoteObjectMatcher(String subsystemConfigurationId, String categoryFilter, String nameFilter, String typeFilter, String subtypeFilter, String subsubtypeFilter)
          Historical constructor that doesn't support "subsystemConfigurationCategory" or "systemTypes".
SystemRemoteObjectMatcher(String subsystemConfigurationId, String subsystemConfigurationCategoryFilter, String categoryFilter, String systemTypes, String nameFilter, String typeFilter, String subtypeFilter, String subsubtypeFilter)
          Constructor that supports "subsystemConfigurationCategory" and "systemTypes".
 
Method Summary
 boolean appliesTo(ISystemRemoteObjectMatchProvider adapter, Object element)
          Given an ISystemRemoteElement, return true if that element meets this criteria.
protected  boolean endsWithAsterisk(String name)
          Helper method.
 String getCategoryFilter()
          Getter method.
 String getNameFilter()
          Getter method.
 String getSubSubTypeFilter()
          Getter method.
 String getSubSystemConfigurationCategoryFilter()
          Getter method.
 String getSubSystemConfigurationId()
          Getter method.
 String getSubTypeFilter()
          Getter method.
 String getSystemTypesFilter()
          Getter method.
 String getTypeFilter()
          Getter method.
protected  String resolveSymbols(String name)
          Occasionally, as with iSeries objects types, an asterisk is a valid part of the name, as in *PGM.
protected  boolean startsWithAsterisk(String name)
          Helper method.
protected  String stripLeadingAsterisk(String name)
          Helper method.
protected  String stripTrailingAsterisk(String name)
          Helper method.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STAR_SYMBOL

public static final String STAR_SYMBOL
See Also:
Constant Field Values

STAR_SYMBOL2

public static final String STAR_SYMBOL2
See Also:
Constant Field Values

STAR_SYMBOL_LEN

public static final int STAR_SYMBOL_LEN
See Also:
Constant Field Values
Constructor Detail

SystemRemoteObjectMatcher

public SystemRemoteObjectMatcher(String subsystemConfigurationId,
                                 String categoryFilter,
                                 String nameFilter,
                                 String typeFilter,
                                 String subtypeFilter,
                                 String subsubtypeFilter)
Historical constructor that doesn't support "subsystemConfigurationCategory" or "systemTypes".


SystemRemoteObjectMatcher

public SystemRemoteObjectMatcher(String subsystemConfigurationId,
                                 String subsystemConfigurationCategoryFilter,
                                 String categoryFilter,
                                 String systemTypes,
                                 String nameFilter,
                                 String typeFilter,
                                 String subtypeFilter,
                                 String subsubtypeFilter)
Constructor that supports "subsystemConfigurationCategory" and "systemTypes".

Method Detail

startsWithAsterisk

protected boolean startsWithAsterisk(String name)
Helper method. Returns true if given name starts with an asterisk.


endsWithAsterisk

protected boolean endsWithAsterisk(String name)
Helper method. Returns true if given name ends with an asterisk.


stripLeadingAsterisk

protected String stripLeadingAsterisk(String name)
Helper method. Strips off the leading asterisk.


stripTrailingAsterisk

protected String stripTrailingAsterisk(String name)
Helper method. Strips off the trailing asterisk.


resolveSymbols

protected String resolveSymbols(String name)
Occasionally, as with iSeries objects types, an asterisk is a valid part of the name, as in *PGM. If "*PGM" is specified for the type filter, then it would match on other types too, like *SRVPGM. To solve this special case, users can specify the following to tell us that the asterisk is to be taken literally, versus as a leading or trailing wild card:

  "%%ast.PGM" or "%%ast;PGM"
 

The special symbol "%%ast." is resolved into an asterisk as part of the literal name.


getSubSystemConfigurationCategoryFilter

public String getSubSystemConfigurationCategoryFilter()
Getter method. Return what was specified for the subsystemconfigurationCategory xml attribute.


getSystemTypesFilter

public String getSystemTypesFilter()
Getter method. Return what was specified for the systemTypes xml attribute.


getCategoryFilter

public String getCategoryFilter()
Getter method. Return what was specified for the typecategoryfilter xml attribute.


getNameFilter

public String getNameFilter()
Getter method. Return what was specified for the namefilter xml attribute.


getTypeFilter

public String getTypeFilter()
Getter method. Return what was specified for the typefilter xml attribute.


getSubTypeFilter

public String getSubTypeFilter()
Getter method. Return what was specified for the subtypefilter xml attribute.


getSubSubTypeFilter

public String getSubSubTypeFilter()
Getter method. Return what was specified for the subsubtypefilter xml attribute.


getSubSystemConfigurationId

public String getSubSystemConfigurationId()
Getter method. Return what was specified for the subsystemconfigurationid xml attribute.


appliesTo

public boolean appliesTo(ISystemRemoteObjectMatchProvider adapter,
                         Object element)
Given an ISystemRemoteElement, return true if that element meets this criteria.


RSE
Release 3.2

Copyright (c) IBM Corporation and others 2000, 2010. All Rights Reserved.