Class RE {Java} derived from: REToken

Documentation
* RE provides the user interface for compiling and matching regular
* expressions.
* 
* A regular expression object (class RE) is compiled by constructing it
* from a String, StringBuffer or character array, with optional
* compilation flags (below)
* and an optional syntax specification (see RESyntax; if not specified,
* <code>RESyntax.RE_SYNTAX_PERL5</code> is used).
* 
* Various methods attempt to match input text against a compiled
* regular expression. These methods are:
* <LI><code>isMatch</code>: returns true if the input text in its entirety
* matches the regular expression pattern.
* <LI><code>getMatch</code>: returns the first match found in the input text,
* or null if no match is found.
* <LI><code>getAllMatches</code>: returns an array of all non-overlapping
* matches found in the input text. If no matches are found, the array is
* zero-length.
* <LI><code>substitute</code>: substitute the first occurence of the pattern
* in the input text with a replacement string (which may include
* metacharacters $0-$9, see REMatch.substituteInto).
* <LI><code>substituteAll</code>: same as above, but repeat for each match
* before returning.
* <LI><code>getMatchEnumeration</code>: returns an REMatchEnumeration object
* that allows iteration over the matches (see REMatchEnumeration for some
* reasons why you may want to do this instead of using <code>getAllMatches</code>.
* 
* These methods all have similar argument lists. The input can be a
* String, a character array, a StringBuffer or an InputStream of some sort.
* Note that
* when using an InputStream, the stream read position cannot be guaranteed
* after attempting a match (this is not a bug, but a consequence of the way
* regular expressions work). Using an REMatchEnumeration can eliminate most
* positioning problems.
* 
* The optional index argument specifies the offset from the beginning of the
* text at which the search should start (see the descriptions of some of
* the execution flags for how this can affect positional pattern operators).
* For an InputStream, this means an offset from the current read position,
* so subsequent calls with the same index argument on an InputStream will not
* necessarily be accessing the same position on the stream, whereas repeated
* searches at a given index in a fixed string will return consistent
* results.
* 
* You can optionally affect the execution environment by using a
* combination of execution flags (constants listed below).
*
* @author <A HREF="mailto:wes@cacas.org">Wes Biggs</A>
* @version 1.0.8, 21 March 1999

Parent Package	regexp	Abstract	No
Export Control	PublicAccess	Link Class for	None
Class Kind	NormalClass	Cardinality	n
Space		Concurrency	Sequential
Persistence	No

Assigned Components

Operations

Name	Signature	Class
version	String version ()	RE
RE	RE (Object pattern)	RE
RE	RE (Object pattern, int cflags)	RE
RE	RE (Object pattern, int cflags, RESyntax syntax)	RE
RE	RE (REToken f_first, REToken f_last, int f_subs, int f_subIndex)	RE
RE	RE (Object patternObj, int cflags, RESyntax syntax, int myIndex, int nextSub)	RE
getCharUnit	int getCharUnit (char[] input, int index, CharUnit unit)	RE
isMatch	boolean isMatch (Object input)	RE
isMatch	boolean isMatch (Object input, int index)	RE
isMatch	boolean isMatch (Object input, int index, int eflags)	RE
isMatchImpl	boolean isMatchImpl (CharIndexed input, int index, int eflags)	RE
getNumSubs	int getNumSubs ()	RE
setUncle	void setUncle (REToken f_uncle)	RE
chain	boolean chain (REToken f_next)	RE
getMinimumLength	int getMinimumLength ()	RE
getAllMatches	REMatch[] getAllMatches (Object input)	RE
getAllMatches	REMatch[] getAllMatches (Object input, int index)	RE
getAllMatches	REMatch[] getAllMatches (Object input, int index, int eflags)	RE
getAllMatchesImpl	REMatch[] getAllMatchesImpl (CharIndexed input, int index, int eflags)	RE
match	int[] match (CharIndexed input, int index, int eflags, REMatch mymatch)	RE
getMatch	REMatch getMatch (Object input)	RE
getMatch	REMatch getMatch (Object input, int index)	RE
getMatch	REMatch getMatch (Object input, int index, int eflags)	RE
getMatch	REMatch getMatch (Object input, int index, int eflags, StringBuffer buffer)	RE
getMatchImpl	REMatch getMatchImpl (CharIndexed input, int index, int eflags, StringBuffer buffer)	RE
getMatchEnumeration	REMatchEnumeration getMatchEnumeration (Object input)	RE
getMatchEnumeration	REMatchEnumeration getMatchEnumeration (Object input, int index)	RE
getMatchEnumeration	REMatchEnumeration getMatchEnumeration (Object input, int index, int eflags)	RE
substitute	String substitute (Object input, String replace)	RE
substitute	String substitute (Object input, String replace, int index)	RE
substitute	String substitute (Object input, String replace, int index, int eflags)	RE
substituteImpl	String substituteImpl (CharIndexed input, String replace, int index, int eflags)	RE
substituteAll	String substituteAll (Object input, String replace)	RE
substituteAll	String substituteAll (Object input, String replace, int index)	RE
substituteAll	String substituteAll (Object input, String replace, int index, int eflags)	RE
substituteAllImpl	String substituteAllImpl (CharIndexed input, String replace, int index, int eflags)	RE
addToken	void addToken (REToken next)	RE
setRepeated	REToken setRepeated (REToken current, int min, int max, int index)	RE
getPosixSet	int getPosixSet (char[] pattern, int index, StringBuffer buf)	RE
getMinMax	int getMinMax (char[] input, int index, IntPair minMax, RESyntax syntax)	RE
toString	String toString ()	RE
dump	void dump (StringBuffer os)	RE
makeCharIndexed	CharIndexed makeCharIndexed (Object input, int index)	RE
REToken	REToken (int f_subIndex)	REToken
getMinimumLength	int getMinimumLength ()	REToken
setUncle	void setUncle (REToken f_uncle)	REToken
match	int[] match (CharIndexed input, int index, int eflags, REMatch mymatch)	REToken
next	int[] next (CharIndexed input, int index, int eflags, REMatch mymatch)	REToken
chain	boolean chain (REToken next)	REToken
dump	void dump (StringBuffer os)	REToken
dumpAll	void dumpAll (StringBuffer os)	REToken

Attributes

Name	Class	Type	Initial Value
m_numSubs	RE	int
REG_ICASE	RE	int	2
REG_DOT_NEWLINE	RE	int	4
REG_MULTILINE	RE	int	8
REG_NOTBOL	RE	int	16
REG_NOTEOL	RE	int	32
REG_ANCHORINDEX	RE	int	64
m_subIndex	REToken	int

Associations

Name	My Role	My Class	Other Role	Other Element
--Not Named--	--Not Named--	RE	s_version	String
--Not Named--	--Not Named--	RE	firstToken	REToken
--Not Named--	--Not Named--	RE	lastToken	REToken
--Not Named--	m_expr	RE	--Not Named--	REFilterInputStream
--Not Named--	m_expr	RE	--Not Named--	REMatchEnumeration
--Not Named--	--Not Named--	RE	firstToken	REToken
--Not Named--	--Not Named--	RE	lastToken	REToken
--Not Named--	--Not Named--	REToken	newline	String
--Not Named--	--Not Named--	REToken	m_next	REToken
--Not Named--	--Not Named--	REToken	m_uncle	REToken
--Not Named--	token	REToken	--Not Named--	RETokenRepeated

Generalization Relationships

Name	Class	Supplier
--Not Named--	RE	REToken

Property Settings

Java

GenerateFinalizer	False	GenerateStaticInitializer	False
GenerateInstanceInitializer	False	GenerateDefaultConstructor	False
Final	False	Static	False
ConstructorIs	public	Ctor_Set	public, protected, private, package
GenerateCode	True	DisableAutoSync	False

Data Modeler

dmItem	False	DMName
IsTable	False	IsView	False
Synonymns		TableSpace
SourceId		SourceType
SelectClause		IsUpdatable	False
CheckOption	0