RSE
Release 3.4

org.eclipse.rse.services.clientserver
Class SystemSearchString

java.lang.Object
  extended by org.eclipse.rse.services.clientserver.SystemSearchString

public class SystemSearchString
extends Object

This class represents search string.


Field Summary
protected  String classificationString
           
static int DEPTH_INFINITE
          Constant indicating that the depth is infinite, -1.
protected  String fileNamesString
           
protected  boolean includeArchives
           
protected  boolean includeSubfolders
           
protected  boolean isCaseSensitive
           
protected  boolean isFileNamesCaseSensitive
           
protected  boolean isFileNamesRegex
           
protected  boolean isTextStringRegex
           
protected  String textString
           
 
Constructor Summary
SystemSearchString(String textString, boolean isCaseSensitive, boolean isTextStringRegex, String fileNamesString, boolean isFileNamesRegex, boolean includeArchives, boolean includeSubfolders)
          Creates a new search string.
SystemSearchString(String textString, boolean isCaseSensitive, boolean isTextStringRegex, String fileNamesString, boolean isFileNamesCaseSensitive, boolean isFileNamesRegex, boolean includeArchives, boolean includeSubfolders)
          Creates a new search string.
SystemSearchString(String textString, boolean isCaseSensitive, boolean isTextStringRegex, String fileNamesString, boolean isFileNamesCaseSensitive, boolean isFileNamesRegex, boolean includeArchives, boolean includeSubfolders, String classificationString)
          Creates a new search string that allows search to be restricted to files with a certain classification.
SystemSearchString(String textString, boolean isCaseSensitive, boolean isTextStringRegex, String fileNamesString, boolean isFileNamesRegex, boolean includeArchives, boolean includeSubfolders, String classificationString)
          Creates a new search string that allows search to be restricted to files with a certain classification.
 
Method Summary
 String getClassificationString()
          Returns the classification string that file classifications should match with.
 String getFileNamesString()
          Returns the file names string.
 String getTextString()
          Returns the text string.
 boolean isCaseSensitive()
          Returns whether the search is case sensitive.
 boolean isFileNamesCaseSensitive()
          Returns whether the file names search is case sensitive.
 boolean isFileNamesRegex()
          Returns whether the file names string is a regular expression.
 boolean isIncludeArchives()
          Returns whether archives should be searched.
 boolean isIncludeSubfolders()
          Returns whether subfolders should be searched.
 boolean isTextStringRegex()
          Returns whether the text string is a regular expression.
 String toString()
          Writes the contents of the search string
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEPTH_INFINITE

public static final int DEPTH_INFINITE
Constant indicating that the depth is infinite, -1.

See Also:
Constant Field Values

textString

protected String textString

isCaseSensitive

protected boolean isCaseSensitive

isTextStringRegex

protected boolean isTextStringRegex

fileNamesString

protected String fileNamesString

isFileNamesCaseSensitive

protected boolean isFileNamesCaseSensitive
Since:
3.1 for determining whether filename should be searched case-sensitive or not

isFileNamesRegex

protected boolean isFileNamesRegex

includeArchives

protected boolean includeArchives

includeSubfolders

protected boolean includeSubfolders

classificationString

protected String classificationString
Constructor Detail

SystemSearchString

public SystemSearchString(String textString,
                          boolean isCaseSensitive,
                          boolean isTextStringRegex,
                          String fileNamesString,
                          boolean isFileNamesRegex,
                          boolean includeArchives,
                          boolean includeSubfolders)
Creates a new search string.

Parameters:
textString - the text string.
isCaseSensitive - true if the search should be case sensitive, false otherwise.
isTextStringRegex - true if the text string is a regular expression, false otherwise.
fileNamesString - the file names pattern.
isFileNamesRegex - true if the file names string is a regular expression, false otherwise.
includeArchives - true to search inside archives, false otherwise.
includeSubfolders - true to search subfolders, false otherwise.

SystemSearchString

public SystemSearchString(String textString,
                          boolean isCaseSensitive,
                          boolean isTextStringRegex,
                          String fileNamesString,
                          boolean isFileNamesCaseSensitive,
                          boolean isFileNamesRegex,
                          boolean includeArchives,
                          boolean includeSubfolders)
Creates a new search string.

Parameters:
textString - the text string.
isCaseSensitive - true if the search should be case sensitive, false otherwise.
isTextStringRegex - true if the text string is a regular expression, false otherwise.
fileNamesString - the file names pattern.
isFileNamesCaseSensitive - true if the file name search should be case sensitive, false otherwise.
isFileNamesRegex - true if the file names string is a regular expression, false otherwise.
includeArchives - true to search inside archives, false otherwise.
includeSubfolders - true to search subfolders, false otherwise.
Since:
3.1

SystemSearchString

public SystemSearchString(String textString,
                          boolean isCaseSensitive,
                          boolean isTextStringRegex,
                          String fileNamesString,
                          boolean isFileNamesRegex,
                          boolean includeArchives,
                          boolean includeSubfolders,
                          String classificationString)
Creates a new search string that allows search to be restricted to files with a certain classification.

Parameters:
textString - the text string.
isCaseSensitive - true if the search should be case sensitive, false otherwise.
isTextStringRegex - true if the text string is a regular expression, false otherwise.
fileNamesString - the file names pattern.
isFileNamesRegex - true if the file names string is a regular expression, false otherwise.
includeArchives - true to search inside archives, false otherwise.
includeSubfolders - true to search subfolders, false otherwise.
classificationString - the classification string that file classifications should match with.

SystemSearchString

public SystemSearchString(String textString,
                          boolean isCaseSensitive,
                          boolean isTextStringRegex,
                          String fileNamesString,
                          boolean isFileNamesCaseSensitive,
                          boolean isFileNamesRegex,
                          boolean includeArchives,
                          boolean includeSubfolders,
                          String classificationString)
Creates a new search string that allows search to be restricted to files with a certain classification.

Parameters:
textString - the text string.
isCaseSensitive - true if the search should be case sensitive, false otherwise.
isTextStringRegex - true if the text string is a regular expression, false otherwise.
fileNamesString - the file names pattern.
isFileNamesCaseSensitive - true if the file name search should be case sensitive, false otherwise.
isFileNamesRegex - true if the file names string is a regular expression, false otherwise.
includeArchives - true to search inside archives, false otherwise.
includeSubfolders - true to search subfolders, false otherwise.
classificationString - the classification string that file classifications should match with.
Since:
3.1
Method Detail

getTextString

public String getTextString()
Returns the text string.

Returns:
the text string.

isCaseSensitive

public boolean isCaseSensitive()
Returns whether the search is case sensitive.

Returns:
true if the search is case sensitive, false otherwise.

isTextStringRegex

public boolean isTextStringRegex()
Returns whether the text string is a regular expression.

Returns:
true if the text string is a regular expression, false otherwise.

getFileNamesString

public String getFileNamesString()
Returns the file names string.

Returns:
the file names string.

isFileNamesCaseSensitive

public boolean isFileNamesCaseSensitive()
Returns whether the file names search is case sensitive.

Returns:
true if the file names search is case sensitive, false otherwise.
Since:
3.1

isFileNamesRegex

public boolean isFileNamesRegex()
Returns whether the file names string is a regular expression.

Returns:
true if the file names string is a regular expression, false otherwise.

isIncludeArchives

public boolean isIncludeArchives()
Returns whether archives should be searched.

Returns:
true to search archives, false otherwise.

isIncludeSubfolders

public boolean isIncludeSubfolders()
Returns whether subfolders should be searched.

Returns:
true to search subfolders, false otherwise.

getClassificationString

public String getClassificationString()
Returns the classification string that file classifications should match with.

Returns:
the classification.

toString

public String toString()
Writes the contents of the search string

Overrides:
toString in class Object
See Also:
Object.toString()

RSE
Release 3.4

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