Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: util ::

constants group SearchFlags
Description
Flags for search methods

Constants
ALL_IGNORE_CASE [ DEPRECATED ]
 
NORM_WORD_ONLY Flag for normal (Boyer-Moore) search / Search for word only.  
REG_EXTENDED [ DEPRECATED ]
Flag for "regular expression" search / Interpret as extended regular expression.  
REG_NOSUB [ DEPRECATED ]
Flag for "regular expression" search / No register information or backreferences, i.e., avoid sub expressions. Return only true/false if matched or not.  
REG_NEWLINE [ DEPRECATED ]
Flag for "regular expression" search / Special new line treatment.  
REG_NOT_BEGINOFLINE The first character in the string is not the beginning of the line therefore ^ will not match with first character of the string.  
REG_NOT_ENDOFLINE The last character in the string is not the end of the line therefore $ will not match with last character of the string.  
LEV_RELAXED Flag for "Weighted Levenshtein Distance" search / Relaxed checking of limit, split weigh pools.  
Constants' Details
ALL_IGNORE_CASE
const long ALL_IGNORE_CASE = 0x00000001;
Usage Restrictions
deprecated
Deprecation Info
The constant ALL_IGNORE_CASE is never supported - use TransliterationModules::IGNORE_CASE with SearchOptions::transliterateFlags instead.
See also
::com::sun::star::i18n::TransliterationModules
NORM_WORD_ONLY
const long NORM_WORD_ONLY = 0x00000010;
Description
Flag for normal (Boyer-Moore) search / Search for word only.
REG_EXTENDED
const long REG_EXTENDED = 0x00000100;
Usage Restrictions
deprecated
Deprecation Info
The flag is currently not supported by OOo.
Description
Flag for "regular expression" search / Interpret as extended regular expression.
REG_NOSUB
const long REG_NOSUB = 0x00000200;
Usage Restrictions
deprecated
Deprecation Info
The flag is currently not supported by OOo.
Description
Flag for "regular expression" search / No register information or backreferences, i.e., avoid sub expressions. Return only true/false if matched or not.
REG_NEWLINE
const long REG_NEWLINE = 0x00000400;
Usage Restrictions
deprecated
Deprecation Info
The flag is currently not supported by OOo.

A NEWLINE character in string will not be matched by a period outside bracket expression or by any form of a non matching list.

A circumflex (^) in pattern when used to specify expression anchoring will match the zero length string immediately after a newline in string, regardless of the setting of REG_NOT_BEGINOFLINE.

A dollar-sign ($) in pattern when used to specify expression anchoring, will match zero-length string immediately before a new line in string, regardless of the setting of REG_NOT_ENDOFLINE.

Description
Flag for "regular expression" search / Special new line treatment.
REG_NOT_BEGINOFLINE
const long REG_NOT_BEGINOFLINE = 0x00000800;
Description
The first character in the string is not the beginning of the line therefore ^ will not match with first character of the string.
REG_NOT_ENDOFLINE
const long REG_NOT_ENDOFLINE = 0x00001000;
Description
The last character in the string is not the end of the line therefore $ will not match with last character of the string.
LEV_RELAXED
const long LEV_RELAXED = 0x00010000;
Description
Flag for "Weighted Levenshtein Distance" search / Relaxed checking of limit, split weigh pools.

If not specified (strict), the search is sucessful if the WLD is within a calculated limit where each insertion, deletion and replacement adds a weight to a common pool of weights. This is the mathematically correct WLD.

From a user's point of view the strict WLD is an exclusive-OR of the arguments given, for example if allowed insertions=2 and allowed replacements=2, the search fails if 2 characters had been inserted and an additional operation would be needed to match. Depending on the weights it may also fail if 1 character was inserted and 1 character replaced and an additional operation would be needed to match. The strict algorithm may match less than expected from a first glance of the specified arguments, but does not return false positives.

If specified (relaxed), the search is also successful if the combined pool for insertions and deletions is below a doubled calculated limit and replacements are treated differently. Additionally, swapped characters are counted as one replacement.

From a user's point of view the relaxed WLD is an inclusive-OR of the arguments given, for example if allowed insertions=2 and allowed replacements=2, the search succeeds if 2 characters had been inserted and an additional replacement is needed to match. The relaxed algorithm may return false positives, but meets user expectation better.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.