LikeSearchOption (DBFlute Runtime 1.1.0-sp2-RC1 API)

java.lang.Object
- org.dbflute.cbean.coption.SimpleStringOption
- - org.dbflute.cbean.coption.LikeSearchOption

すべての実装されたインタフェース:: ConditionOption, FilteringBindOption

直系の既知のサブクラス:: AbstractConditionQuery.OracleMatchLikeSearch, AbstractConditionQuery.PostgreSQLMatchLikeSearch

public class LikeSearchOption
extends SimpleStringOption
implements FilteringBindOption

The option of like search.

 e.g.
  new LikeSearchOption().likePrefix()  : PrefixSearch
  new LikeSearchOption().likeContain() : ContainSearch
  new LikeSearchOption().likeSuffix()  : SuffixSearch

作成者:: jflute

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected boolean`	`_asOrSplit`
`protected GearedCipherManager`	`_cipherManager`
`protected List<SpecifiedColumn>`	`_compoundColumnList`
`protected List<Integer>`	`_compoundColumnSizeList`
`protected String`	`_escape`
`protected String`	`_like`
`protected List<String>`	`_originalWildCardList`
`protected OnQueryStringConnector`	`_stringConnector`
`protected static String`	`LIKE_CONTAIN`
`protected static String`	`LIKE_PREFIX`
`protected static String`	`LIKE_SUFFIX`

クラスから継承されたフィールド org.dbflute.cbean.coption.SimpleStringOption
_splitOptionParts

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

LikeSearchOption()
Construct the option of like search normally.

コンストラクタ
コンストラクタと説明
`LikeSearchOption()` Construct the option of like search normally.

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`void`	`acceptGearedCipherManager(GearedCipherManager cipherManager)` Accept the manager of geared cipher.
`LikeSearchOption`	`acceptOriginalWildCardList(List<String> originalWildCardList)`
`LikeSearchOption`	`acceptStringConnector(OnQueryStringConnector stringConnector)`
`LikeSearchOption`	`addCompoundColumn(SpecifiedColumn compoundColumn)` Add compound column connected to main column.
`LikeSearchOption`	`asOrSplit()` Split as OR condition.
`protected void`	`assertCompoundColumnPrecondition(SpecifiedColumn compoundColumn)`
`protected void`	`assertCompoundColumnSpecifiedColumn(SpecifiedColumn compoundColumn)`
`protected void`	`assertSplitByPrecondition()`
`boolean`	`canOptimizeCompoundColumnLikePrefix()`
`void`	`clearCompoundColumn()`
`LikeSearchOption`	`createDeepCopy()`
`LikeSearchOption`	`cutSplit(int splitLimitCount)` Cut the large split (set limit count for split).
`protected void`	`doLikeAutoEscape()`
`LikeSearchOption`	`escape()` Escape like search by pipe-line '\|'.
`LikeSearchOption`	`escapeByAtMark()`
`LikeSearchOption`	`escapeByBackSlash()`
`LikeSearchOption`	`escapeByPipeLine()`
`LikeSearchOption`	`escapeBySlash()`
`protected String`	`filterEscape(String target, String wildCard)`
`String`	`generateRealValue(String value)`
`List<SpecifiedColumn>`	`getCompoundColumnList()` Get the list of compound columns.
`List<Integer>`	`getCompoundColumnSizeList()`
`ExtensionOperand`	`getExtensionOperand()` Get the operand for extension.
`GearedCipherManager`	`getGearedCipherManager()` Get the manager of geared cipher.
`String`	`getRearOption()` Get the string expression of rear option.
`OnQueryStringConnector`	`getStringConnector()` Get the string connector basically for compound columns?
`QueryClauseArranger`	`getWhereClauseArranger()` Get the arranger of where clause.
`boolean`	`hasCompoundColumn()` Does the option have compound columns?
`boolean`	`hasCompoundColumnOptimization()`
`boolean`	`hasStringConnector()` Does the option have string connector basically for compound columns?
`boolean`	`isAsOrSplit()`
`boolean`	`isLikeContain()`
`boolean`	`isLikePrefix()`
`boolean`	`isLikeSuffix()`
`LikeSearchOption`	`likeContain()` Set up contain-search. e.g. like '%foo%' escape '\|'
`LikeSearchOption`	`likePrefix()` Set up prefix-search. e.g. like 'foo%' escape '\|'
`LikeSearchOption`	`likeSuffix()` Set up suffix-search. e.g. like '%foo' escape '\|'
`protected LikeSearchOption`	`newDeepCopyInstance()`
`LikeSearchOption`	`notEscape()`
`LikeSearchOption`	`optimizeCompoundColumnByFixedSize(Integer... sizes)` Optimize compound columns by fixed size.
`LikeSearchOption`	`splitByBlank()` Split a value as several condition by blank (space, full-width space, tab, CR, LF).
`LikeSearchOption`	`splitByPipeLine()` Split a value as several condition by pipeline.
`LikeSearchOption`	`splitBySpace()` Split a value as several condition by half-size space.
`LikeSearchOption`	`splitBySpaceContainsDoubleByte()` Split a value as several condition by space that contains full-width space.
`LikeSearchOption`	`splitByVarious(List<String> delimiterList)` Split a value as several condition by specified various delimiters.
`String`	`toString()`

クラスから継承されたメソッド org.dbflute.cbean.coption.SimpleStringOption
createSplitOptionParts, doCutSplit, doSplitByBlank, doSplitByPipeLine, doSplitBySpace, doSplitBySpaceContainsDoubleByte, doSplitBySpaceContainsDoubleByte, doSplitByVarious, generateSplitValueArray, getSplitOptionParts, isSplit, replace

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- フィールドの詳細
  - LIKE_PREFIX
```
protected static final String LIKE_PREFIX
```
    関連項目:
    
    定数フィールド値
  - LIKE_SUFFIX
```
protected static final String LIKE_SUFFIX
```
    関連項目:
    
    定数フィールド値
  - LIKE_CONTAIN
```
protected static final String LIKE_CONTAIN
```
    関連項目:
    
    定数フィールド値
  - _like
```
protected String _like
```
  - _escape
```
protected String _escape
```
  - _asOrSplit
```
protected boolean _asOrSplit
```
  - _originalWildCardList
```
protected List<String> _originalWildCardList
```
  - _compoundColumnList
```
protected List<SpecifiedColumn> _compoundColumnList
```
  - _compoundColumnSizeList
```
protected List<Integer> _compoundColumnSizeList
```
  - _stringConnector
```
protected OnQueryStringConnector _stringConnector
```
  - _cipherManager
```
protected GearedCipherManager _cipherManager
```
- コンストラクタの詳細
  - LikeSearchOption
```
public LikeSearchOption()
```
    Construct the option of like search normally.
```
 e.g.
  new LikeSearchOption().likePrefix()  : PrefixSearch
  new LikeSearchOption().likeContain() : ContainSearch
  new LikeSearchOption().likeSuffix()  : SuffixSearch
 
  new LikeSearchOption().likeContain().splitByBlank()
  new LikeSearchOption().likeContain().splitByBlank().asOrSplit()
 
```
- メソッドの詳細
  - getRearOption
```
public String getRearOption()
```
    インタフェースからコピーされた説明: ConditionOption
    
    Get the string expression of rear option.
    
    定義:
    
    getRearOption インタフェース内 ConditionOption
    
    定義:
    
    getRearOption インタフェース内 FilteringBindOption
    
    オーバーライド:
    
    getRearOption クラス内 SimpleStringOption
    
    戻り値:
    
    The string for rear option. (NotNull, EmptyAllowed)
  - likePrefix
```
public LikeSearchOption likePrefix()
```
    Set up prefix-search. e.g. like 'foo%' escape '|'
    
    戻り値:
    
    this. (NotNull)
  - likeSuffix
```
public LikeSearchOption likeSuffix()
```
    Set up suffix-search. e.g. like '%foo' escape '|'
    
    戻り値:
    
    this. (NotNull)
  - likeContain
```
public LikeSearchOption likeContain()
```
    Set up contain-search. e.g. like '%foo%' escape '|'
    
    戻り値:
    
    this. (NotNull)
  - doLikeAutoEscape
```
protected void doLikeAutoEscape()
```
  - isLikePrefix
```
public boolean isLikePrefix()
```
  - isLikeSuffix
```
public boolean isLikeSuffix()
```
  - isLikeContain
```
public boolean isLikeContain()
```
  - escape
```
public LikeSearchOption escape()
```
    Escape like search by pipe-line '|'.
    
    戻り値:
    
    The option of like search. (NotNull)
  - escapeByPipeLine
```
public LikeSearchOption escapeByPipeLine()
```
  - escapeByAtMark
```
public LikeSearchOption escapeByAtMark()
```
  - escapeBySlash
```
public LikeSearchOption escapeBySlash()
```
  - escapeByBackSlash
```
public LikeSearchOption escapeByBackSlash()
```
  - notEscape
```
public LikeSearchOption notEscape()
```
  - splitByBlank
```
public LikeSearchOption splitByBlank()
```
    Split a value as several condition by blank (space, full-width space, tab, CR, LF).
```
 e.g. 'and' condition
 LikeSearchOption option = new LikeSearchOption();
 option.likeContain().splitByBlank();
 cb.query().setFoo_ContainSearch("ab g kl", option);
 // FOO like '%ab%' and FOO like '%g%' and FOO like '%kl%'
 // (all conditions have escape statements)
 
 e.g. 'or' condition
 LikeSearchOption option = new LikeSearchOption();
 option.likeContain().splitByBlank().asOrSplit();
 cb.query().setFoo_ContainSearch("ab g kl", option);
 // FOO like '%ab%' or FOO like '%g%' or FOO like '%kl%'
 // (conditions have escape statements)
 
```
    戻り値:
    
    this. (NotNull)
  - splitBySpace
```
public LikeSearchOption splitBySpace()
```
    Split a value as several condition by half-size space.
    
    戻り値:
    
    this. (NotNull)
  - splitBySpaceContainsDoubleByte
```
public LikeSearchOption splitBySpaceContainsDoubleByte()
```
    Split a value as several condition by space that contains full-width space.
    
    戻り値:
    
    this. (NotNull)
  - splitByPipeLine
```
public LikeSearchOption splitByPipeLine()
```
    Split a value as several condition by pipeline.
    
    戻り値:
    
    this. (NotNull)
  - splitByVarious
```
public LikeSearchOption splitByVarious(List<String> delimiterList)
```
    Split a value as several condition by specified various delimiters.
    
    パラメータ:
    
    delimiterList - The list of delimiter for split. (NotNull, NotEmpty)
    
    戻り値:
    
    this. (NotNull)
  - assertSplitByPrecondition
```
protected void assertSplitByPrecondition()
```
  - asOrSplit
```
public LikeSearchOption asOrSplit()
```
    Split as OR condition.
    You should call this with a splitByXxx method.
    
    戻り値:
    
    this. (NotNull)
  - isAsOrSplit
```
public boolean isAsOrSplit()
```
  - cutSplit
```
public LikeSearchOption cutSplit(int splitLimitCount)
```
    Cut the large split (set limit count for split).
    
    パラメータ:
    
    splitLimitCount - The limit count of split. (NotZero, NotMinus)
    
    戻り値:
    
    this.
  - addCompoundColumn
```
public LikeSearchOption addCompoundColumn(SpecifiedColumn compoundColumn)
```
    Add compound column connected to main column. {Dream Cruise}
```
 e.g. LikeSearch: MEMBER_NAME || MEMBER_ACCOUNT like ...
  MemberCB cb = new MemberCB();
  LikeSearchOption option = new LikeSearchOption().likeContain()
      .addCompoundColumn(cb.dreamCruiseCB().specify().columnMemberAccount());
  cb.query().setMemberName_LikeSearch("S", option);
 
```
    パラメータ:
    
    compoundColumn - The compound column specified by Dream Cruise. (NotNull)
    
    戻り値:
    
    this. (NotNull)
  - assertCompoundColumnPrecondition
```
protected void assertCompoundColumnPrecondition(SpecifiedColumn compoundColumn)
```
  - assertCompoundColumnSpecifiedColumn
```
protected void assertCompoundColumnSpecifiedColumn(SpecifiedColumn compoundColumn)
```
  - hasCompoundColumn
```
public boolean hasCompoundColumn()
```
    インタフェースからコピーされた説明: ConditionOption
    
    Does the option have compound columns?
    
    定義:
    
    hasCompoundColumn インタフェース内 ConditionOption
    
    オーバーライド:
    
    hasCompoundColumn クラス内 SimpleStringOption
    
    戻り値:
    
    The determination, true or false.
  - getCompoundColumnList
```
public List<SpecifiedColumn> getCompoundColumnList()
```
    インタフェースからコピーされた説明: ConditionOption
    
    Get the list of compound columns.
    
    定義:
    
    getCompoundColumnList インタフェース内 ConditionOption
    
    オーバーライド:
    
    getCompoundColumnList クラス内 SimpleStringOption
    
    戻り値:
    
    The list of specified column. (NotNull, EmptyAllowed)
  - clearCompoundColumn
```
public void clearCompoundColumn()
```
  - optimizeCompoundColumnByFixedSize
```
public LikeSearchOption optimizeCompoundColumnByFixedSize(Integer... sizes)
```
    Optimize compound columns by fixed size.
    The columns specified their sizes should be fixed-size string type 'char'. (but no check so attention)
    
    パラメータ:
    
    sizes - The array of column size for main column and compound columns. (NotNull)
    
    戻り値:
    
    this. (NotNull)
  - canOptimizeCompoundColumnLikePrefix
```
public boolean canOptimizeCompoundColumnLikePrefix()
```
  - hasCompoundColumnOptimization
```
public boolean hasCompoundColumnOptimization()
```
  - getCompoundColumnSizeList
```
public List<Integer> getCompoundColumnSizeList()
```
  - acceptStringConnector
```
public LikeSearchOption acceptStringConnector(OnQueryStringConnector stringConnector)
```
    定義:
    
    acceptStringConnector インタフェース内 FilteringBindOption
    
    パラメータ:
    
    stringConnector - The connector of string on query. (NotNull)
    
    戻り値:
    
    this. (NotNull)
  - hasStringConnector
```
public boolean hasStringConnector()
```
    インタフェースからコピーされた説明: ConditionOption
    
    Does the option have string connector basically for compound columns?
    
    定義:
    
    hasStringConnector インタフェース内 ConditionOption
    
    オーバーライド:
    
    hasStringConnector クラス内 SimpleStringOption
    
    戻り値:
    
    The determination, true or false.
  - getStringConnector
```
public OnQueryStringConnector getStringConnector()
```
    インタフェースからコピーされた説明: ConditionOption
    
    Get the string connector basically for compound columns?
    
    定義:
    
    getStringConnector インタフェース内 ConditionOption
    
    オーバーライド:
    
    getStringConnector クラス内 SimpleStringOption
    
    戻り値:
    
    The object of string connector. (NullAllowed)
  - generateRealValue
```
public String generateRealValue(String value)
```
    定義:
    
    generateRealValue インタフェース内 FilteringBindOption
    
    オーバーライド:
    
    generateRealValue クラス内 SimpleStringOption
    
    パラメータ:
    
    value - The filtered value. (NullAllowed: if null, returns null)
    
    戻り値:
    
    The generated real value on SQL expression. (NullAllowed: when the value is null)
  - filterEscape
```
protected String filterEscape(String target,
                              String wildCard)
```
  - acceptOriginalWildCardList
```
public LikeSearchOption acceptOriginalWildCardList(List<String> originalWildCardList)
```
  - createDeepCopy
```
public LikeSearchOption createDeepCopy()
```
    オーバーライド:
    
    createDeepCopy クラス内 SimpleStringOption
  - newDeepCopyInstance
```
protected LikeSearchOption newDeepCopyInstance()
```
    オーバーライド:
    
    newDeepCopyInstance クラス内 SimpleStringOption
  - getExtensionOperand
```
public ExtensionOperand getExtensionOperand()
```
    Get the operand for extension.
    
    定義:
    
    getExtensionOperand インタフェース内 ConditionOption
    
    オーバーライド:
    
    getExtensionOperand クラス内 SimpleStringOption
    
    戻り値:
    
    The operand for extension. (NullAllowed: If the value is null, it means no extension)
  - getWhereClauseArranger
```
public QueryClauseArranger getWhereClauseArranger()
```
    Get the arranger of where clause.
    
    定義:
    
    getWhereClauseArranger インタフェース内 ConditionOption
    
    オーバーライド:
    
    getWhereClauseArranger クラス内 SimpleStringOption
    
    戻り値:
    
    The arranger of where clause. (NullAllowed: If the value is null, it means no arrangement)
  - acceptGearedCipherManager
```
public void acceptGearedCipherManager(GearedCipherManager cipherManager)
```
    Accept the manager of geared cipher. (basically for compound columns)
    
    パラメータ:
    
    cipherManager - The manager of geared cipher. (NullAllowed)
  - getGearedCipherManager
```
public GearedCipherManager getGearedCipherManager()
```
    インタフェースからコピーされた説明: ConditionOption
    
    Get the manager of geared cipher. (basically for compound columns)
    
    定義:
    
    getGearedCipherManager インタフェース内 ConditionOption
    
    オーバーライド:
    
    getGearedCipherManager クラス内 SimpleStringOption
    
    戻り値:
    
    The manager of geared cipher. (NullAllowed)
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object

クラス LikeSearchOption

フィールドのサマリー

クラスから継承されたフィールド org.dbflute.cbean.coption.SimpleStringOption

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド org.dbflute.cbean.coption.SimpleStringOption

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

LIKE_PREFIX

LIKE_SUFFIX

LIKE_CONTAIN

_like

_escape

_asOrSplit

_originalWildCardList

_compoundColumnList

_compoundColumnSizeList

_stringConnector

_cipherManager

コンストラクタの詳細

LikeSearchOption

メソッドの詳細

getRearOption

likePrefix

likeSuffix

likeContain

doLikeAutoEscape

isLikePrefix

isLikeSuffix

isLikeContain

escape

escapeByPipeLine

escapeByAtMark

escapeBySlash

escapeByBackSlash

notEscape

splitByBlank

splitBySpace

splitBySpaceContainsDoubleByte

splitByPipeLine

splitByVarious

assertSplitByPrecondition

asOrSplit

isAsOrSplit

cutSplit

addCompoundColumn

assertCompoundColumnPrecondition

assertCompoundColumnSpecifiedColumn

hasCompoundColumn

getCompoundColumnList

clearCompoundColumn

optimizeCompoundColumnByFixedSize

canOptimizeCompoundColumnLikePrefix

hasCompoundColumnOptimization

getCompoundColumnSizeList

acceptStringConnector

hasStringConnector

getStringConnector

generateRealValue

filterEscape

acceptOriginalWildCardList

createDeepCopy

newDeepCopyInstance

getExtensionOperand

getWhereClauseArranger

acceptGearedCipherManager

getGearedCipherManager

toString