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" );


Field Summary
static java.lang.String copyright
           
static java.lang.String EQUAL
           
static java.lang.String GREATER
           
static java.lang.String GREATER_EQUAL
           
static int KEYWORD
           
static int LABEL
           
static java.lang.String LOWER
           
static java.lang.String LOWER_EQUAL
           
static int NAME
           
static int PACKAGE
           
static int PROJECT
           
 
Method Summary
 java.lang.String getDomain()
           
 java.lang.String getExpression()
           
 java.util.Set<java.lang.String> getFilteredTypes()
           
 int getLevel()
           
 java.lang.String getLevelOperand()
           
 int getLimitTo()
           
 java.lang.String getLocationName()
           
 boolean isCaseSensitive()
           
 void setCaseSensitive(boolean caseSensitive)
           
 void setDomain(java.lang.String domain)
           
 void setExpression(java.lang.String expression)
           
 void setLevel(int level)
           
 void setLevelOperand(java.lang.String levelOperand)
           
 void setLimitTo(int limitTo)
          

Sets the retained design artifacts attribute for the search request.

 void setLocationName(java.lang.String locationName)
           
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values

EQUAL

static final java.lang.String EQUAL

See Also:
Constant Field Values

GREATER

static final java.lang.String GREATER

See Also:
Constant Field Values

GREATER_EQUAL

static final java.lang.String GREATER_EQUAL

See Also:
Constant Field Values

KEYWORD

static final int KEYWORD

Search is based on the keyword.

See Also:
Constant Field Values

LABEL

static final int LABEL

Search is based on the label.

See Also:
Constant Field Values

LOWER

static final java.lang.String LOWER

See Also:
Constant Field Values

LOWER_EQUAL

static final java.lang.String LOWER_EQUAL

See Also:
Constant Field Values

NAME

static final int NAME

Search is based on the name.

See Also:
Constant Field Values

PACKAGE

static final int PACKAGE

Search is based on the package name.

See Also:
Constant Field Values

PROJECT

static final int PROJECT

Search is based on the project name.

See Also:
Constant Field Values
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 :

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 the location name to search for.

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.

Parameters:
domain -

setExpression

void setExpression(java.lang.String expression)

Sets the expression for the search criteria.

Parameters:
expression -

setLevel

void setLevel(int level)

Sets the current level for the search request.

Parameters:
level -

setLevelOperand

void setLevelOperand(java.lang.String levelOperand)

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

Parameters:
levelOperand -

setLimitTo

void setLimitTo(int limitTo)

Sets the retained design artifacts attribute for the search request.

Parameters:
limitTo -

setLocationName

void setLocationName(java.lang.String locationName)

Sets the location name to search for. If null search will be done on all opened locations.

Parameters:
locationName -