com.ibm.pdp.maf.rpp.service

Interface IMAFSearchPattern



  • public interface IMAFSearchPattern

    This interface defines a search pattern to retrieve MAF model elements.

    Example :

    IMAFModelService mafService = MAFModelService.getInstance();

    mafService.openLocation ("MyLocation");

    MAFSearchPattern searchPattern = new MAFSearchPattern();

    searchPattern.setExpression("PRG*");

    searchPattern.getFilteredTypes().add("pacprogram");

    searchPattern.setLimitTo(IMAFSearchPattern.NAME);

    List results = mafService.search(searchPattern);

    mafService.closeLocation( "MyLocation" );

    • Method Detail

      • getDomain

        java.lang.String getDomain()

        Returns the retained domain for the search request.

        Returns:
      • getExpression

        java.lang.String getExpression()

        Returns the expression for the search criteria.

        Returns:
      • getFilteredTypes

        java.util.Set<java.lang.String> getFilteredTypes()

        Returns the list of filtered types. If empty search will be done on all types.

        Valid types are :

        • dataaggregate,dataelement,dataunit,pacblockbase,pacdialog,pacscreen,pacdialogserver,pacserver,paclibrary,pacmacro,pacprogram,pacreport,pactext,metaentity,metaentitytype,metadataaggregate

        • and all meta entity types.

        Returns:
      • getLevel

        int getLevel()

        Returns the current level for the search request.

        Returns:
      • getLevelOperand

        java.lang.String getLevelOperand()

        Returns visibility used from the current level for the search request.

        Returns:
      • getLimitTo

        int getLimitTo()

        Returns the retained design artifacts attribute for the search request.

        Returns:
      • getLocationName

        java.lang.String getLocationName()
        Returns:
      • getSearchIn

        int getSearchIn()
        Returns:
      • getSearchInProjects

        java.util.Set<java.lang.String> getSearchInProjects()
        Returns:
      • isCaseSensitive

        boolean isCaseSensitive()

        Returns the case sensitive criteria.

        Returns:
      • setCaseSensitive

        void setCaseSensitive(boolean caseSensitive)

        Sets the case sensitive criteria for the expression.

        Parameters:
        caseSensitive -
      • setDomain

        void setDomain(java.lang.String domain)

        Sets the retained domain for the search request.

        • The diagram represents the hierarchy of the projects contained in the location. It is defined in the design build path wizard. You open this wizard by right-clicking a location in the Design Explorer view and selecting Properties. The notions of application domain and level (position in the diagram) are associated with each project. You can limit the search scope to some Domain and Level values that exist in the build path.

        • A domain groups the projects according to application criteria. You can indicate here one or more existing domains.

        Parameters:
        domain -
      • setExpression

        void setExpression(java.lang.String expression)

        Sets the expression for the search criteria.

        • This is the character string you want to search for. This string represents the whole or partial name of the element on which the search is performed.

        • You can use the following wildcard characters:

          • An asterisk matches one or more characters of any value.

          • A question mark matches a single character of any value.

        Parameters:
        expression -
      • setLevel

        void setLevel(int level)

        Sets the current level for the search request.

        • In a tree organization, the level implicitly corresponds to the position of a project in the tree. The root node has a level 0. The children nodes of the root have a level 1, and so on. The final leaves of the tree have the highest levels.

        • In a layer organization, the level is associated with each layer. The layer that groups the projects required by all the other projects has a level 0. The layer that groups the projects not required by any other project has the highest level.

        Parameters:
        level -
      • setLevelOperand

        void setLevelOperand(java.lang.String levelOperand)

        Sets visibility used from the current level for the search request.

        • GREATER: strictly greater the current level,

        • GREATER_EQUAL: strictly greater the current level,

        • EQUAL: strictly greater the current level,

        • LOWER_EQUAL: strictly greater the current level,

        • LOWER: strictly greater the current level.

        Parameters:
        levelOperand -
      • setLimitTo

        void setLimitTo(int limitTo)

        Sets the retained design artifacts attribute for the search request.

        • NAME: for name,

        • PACKAGE: for package name,

        • KEYWORD: for keyword,

        • LABEL: for label.

        Parameters:
        limitTo -
      • setLocationName

        void setLocationName(java.lang.String locationName)
        Parameters:
        locationName -
      • setSearchIn

        void setSearchIn(int searchIn)
        Parameters:
        searchIn -