de.frame4j.text

Class CleverSSS.Simple

java.lang.Object

de.frame4j.text.CleverSSS

de.frame4j.text.CleverSSS.Simple

All Implemented Interfaces:

CharSequence, Comparable<CleverSSS>

Enclosing class:

CleverSSS

@MinDoc(copyright="Copyright 2010  A. Weinert",
        author="Albrecht Weinert",
        version="see enclosing class CleverSSS",
        lastModified="see enclosing class CleverSSS",
        lastModifiedBy="see enclosing class CleverSSS",
        usage="make and use for optimistic substring search",
        purpose="make the searches implemented in (abstract) super class available if adequate")
public static class CleverSSS.Simple
extends CleverSSS

Simple substring search, clever only for the short and optimistic cases.

As all optimistic cases are perfectly handled in the abstract class CleverSSS these cases are made available hereby.

Additionally this class provides the simple loop in loop search algorithm and may so act as a reference implementation for all other inheritors.

See Also:

enclosing class

Nested Class Summary

Nested classes/interfaces inherited from class de.frame4j.text.CleverSSS

CleverSSS.Simple

Field Summary

Fields inherited from class de.frame4j.text.CleverSSS

algName, ignoreCase, ignoreWS, len, mskMod, optimisticOK, primF, subC

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Simple(boolean ignoreCase, boolean ignoreWS) Constructor for the empty search sequence cases.
protected	Simple(char[] subC, boolean ignoreCase, boolean ignoreWS, boolean optimisticOK) Constructor for superclass / factory use, no checks.
protected	Simple(char subOne, boolean ignoreCase, boolean ignoreWS) Constructor for the single character case.

Method Summary

Modifier and Type	Method and Description
protected long	implAlgWhere(CharSequence sequ, int lk, int sI, int mxSi) The algorithmic implementation of whereImpl().

Methods inherited from class de.frame4j.text.CleverSSS

allWhere, asPair, asPairs, charAt, commonState, compareTo, endIndexOf, endIndexOf, equals, hashCode, implAlgWhere, indexOf, indexOf, lastIndexOf, lastIndexOf, lastWhereImpl, length, make, make, makeSimple, pair2long, state, subSequence, toCharA, toString, where, where, whereImpl

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Constructor Detail

Simple

protected Simple(char subOne,
                 boolean ignoreCase,
                 boolean ignoreWS)

Constructor for the single character case.

If CleverSSS.ignoreWS is true and subOne is a space (<=' ') this is considered as the empty sequence case.

Parameters:

subOne - single character search sequence

See Also:

CleverSSS.ignoreCase, CleverSSS.ignoreWS

Simple

protected Simple(boolean ignoreCase,
                 boolean ignoreWS)

Constructor for the empty search sequence cases.

This constructor for superclass / factory use is for the trivial case of searching for an empty sequence. Empty means length 0 or null from start or after ignoring white space if so requested.

See Also:

CleverSSS.ignoreCase, CleverSSS.ignoreWS

Simple

protected Simple(char[] subC,
                 boolean ignoreCase,
                 boolean ignoreWS,
                 boolean optimisticOK)

Constructor for superclass / factory use, no checks.

This constructor for superclass / factory use transfers all parameter values to (final) object state without any checks. It is the responsibility of respective factory not to supply inconsistent or illegal parameters.
The only exception from this "blind trust" is CleverSSS.optimisticOK being forced to true regardless of the parameter if subC is null, empty or of length one.

Parameters:

subC - the sequence to search for

optimisticOK - true for trivial (length <= 1) cases as well as those where an optimistic O(n) left to right search is feasible

See Also:

CleverSSS.ignoreCase, CleverSSS.ignoreWS

Method Detail

implAlgWhere

protected long implAlgWhere(CharSequence sequ,
                            int lk,
                            int sI,
                            int mxSi)

The algorithmic implementation of whereImpl().

The method CleverSSS.whereImpl(CharSequence, int, int) does all parameter checks and handles all exceptional / illegal cases by returning -1. It also handles the optimistic cases.

As this class is manly for those optimistic cases, this method is not called for those.

This method implements the (not so clever) loop in loop search algorithm as is done so in String with the extra of handling both ignore case and CleverSSS.ignoreWS. By that this is CleverSSS's reference implementation for all its inheritors.

Specified by:

implAlgWhere in class CleverSSS

Parameters:

sequ - the sequence to search in

lk - its correct or shortened) length

sI - the starting index for the search

mxSi - the maximum possible value of the match index

Returns:

first index and last index + 1 where sub was found (combined in one long, first index in the lower 32 bits) or -1 if no match