NBClause

@interface NBClause : NSObject <NSCopying>

Clauseクラス

Queryの検索条件として使用する。

  • keyで指定されたフィールドの値が、valueで指定された値と等しいこと。

    Declaration

    Objective-C

    + (nonnull NBClause *)equals:(nonnull NSString *)key value:(nonnull id)value;

    Swift

    class func equals(_ key: String, value: Any) -> NBClause

    Parameters

    key

    演算対象のフィールド
    value

    値

    Return Value

    条件を設定したNBClauseのインスタンス

  • keyで指定されたフィールドの値が、valueで指定された値と等しくないこと。

    Declaration

    Objective-C

    + (nonnull NBClause *)notEquals:(nonnull NSString *)key value:(nonnull id)value;

    Swift

    class func notEquals(_ key: String, value: Any) -> NBClause

    Parameters

    key

    演算対象のフィールド
    value

    値

    Return Value

    条件を設定したNBClauseのインスタンス

  • keyで指定されたフィールドの値が、valueで指定された値より小さいこと。

    Declaration

    Objective-C

    + (nonnull NBClause *)lessThan:(nonnull NSString *)key value:(nonnull id)value;

    Swift

    class func lessThan(_ key: String, value: Any) -> NBClause

    Parameters

    key

    演算対象のフィールド
    value

    値

    Return Value

    条件を設定したNBClauseのインスタンス

  • keyで指定されたフィールドの値が、valueで指定された値以下であること。

    Declaration

    Objective-C

    + (nonnull NBClause *)lessThanOrEqual:(nonnull NSString *)key
                                value:(nonnull id)value;

    Swift

    class func lessThanOrEqual(_ key: String, value: Any) -> NBClause

    Parameters

    key

    演算対象のフィールド
    value

    値

    Return Value

    条件を設定したNBClauseのインスタンス

  • keyで指定されたフィールドの値が、valueで指定された値より大きいこと。

    Declaration

    Objective-C

    + (nonnull NBClause *)greaterThan:(nonnull NSString *)key
                            value:(nonnull id)value;

    Swift

    class func greaterThan(_ key: String, value: Any) -> NBClause

    Parameters

    key

    演算対象のフィールド
    value

    値

    Return Value

    条件を設定したNBClauseのインスタンス

  • keyで指定されたフィールドの値が、valueで指定された値以上であること。

    Declaration

    Objective-C

    + (nonnull NBClause *)greaterThanOrEqual:(nonnull NSString *)key
                                   value:(nonnull id)value;

    Swift

    class func greaterThanOrEqual(_ key: String, value: Any) -> NBClause

    Parameters

    key

    演算対象のフィールド
    value

    値

    Return Value

    条件を設定したNBClauseのインスタンス

  • keyで指定されたフィールドの値が、valueで指定された値のいずれかに一致すること。

    Declaration

    Objective-C

    + (nonnull NBClause *)in:(nonnull NSString *)key
                   value:(nonnull NSArray *)values;

    Swift

    class func `in`(_ key: String, value values: [Any]) -> NBClause

    Parameters

    key

    演算対象のフィールド
    value

    値

    Return Value

    条件を設定したNBClauseのインスタンス

  • keyで指定されたフィールドの値が、valueで指定された値の全てに一致すること。

    Declaration

    Objective-C

    + (nonnull NBClause *)all:(nonnull NSString *)key
                    value:(nonnull NSArray *)values;

    Swift

    class func all(_ key: String, value values: [Any]) -> NBClause

    Parameters

    key

    演算対象のフィールド
    value

    値

    Return Value

    条件を設定したNBClauseのインスタンス

  • keyで指定されたフィールドの値の有無。

    Declaration

    Objective-C

    + (nonnull NBClause *)exists:(nonnull NSString *)key value:(BOOL)value;

    Swift

    class func exists(_ key: String, value: Bool) -> NBClause

    Parameters

    key

    演算対象のフィールド
    value

    値は以下のように扱う YES: 存在する NO:存在しない

    Return Value

    条件を設定したNBClauseのインスタンス

  • keyで指定されたフィールドの値が、正規表現で与えられた表記と一致すること。

    Declaration

    Objective-C

    + (nonnull NBClause *)regex:(nonnull NSString *)key
                 expression:(nonnull NSString *)value
                    options:(NBRegexCaseOptions)options;

    Swift

    class func regex(_ key: String, expression value: String, options: NBRegexCaseOptions = []) -> NBClause

    Parameters

    key

    演算対象のフィールド
    value

    正規表現
    options

    オプション　設定値はNBRegexCaseOptionを参照。複数条件は|で和をとって設定可能である。

    Return Value

    条件を設定したNBClauseのインスタンス

  • 引数で与えられた検索条件のandをとる。

    Declaration

    Objective-C

    + (nonnull NBClause *) and:(nonnull NSArray<NBClause *> *)clauses;

    Swift

    class func and(_ clauses: [NBClause]) -> NBClause

    Parameters

    clauses

    条件を設定したClauseの配列

    Return Value

    条件を設定したNBClauseのインスタンス

  • 引数で与えられた検索条件のorをとる。

    Declaration

    Objective-C

    + (nonnull NBClause *) or:(nonnull NSArray<NBClause *> *)clauses;

    Swift

    class func or(_ clauses: [NBClause]) -> NBClause

    Parameters

    clauses

    条件を設定したClauseの配列

    Return Value

    条件を設定したNBClauseのインスタンス

  • 引数で与えられた検索条件のnotをとる。

    Declaration

    Objective-C

    + (nonnull NBClause *) not:(nonnull NBClause *)clause;

    Swift

    class func not(_ clause: NBClause) -> NBClause

    Parameters

    clauses

    条件を設定したClause

    Return Value

    条件を設定したNBClauseのインスタンス

  • 設定された条件をNSDictionary形式で返却する

    Declaration

    Objective-C

    - (nonnull NSDictionary<NSString *, id> *)dictionaryValue;

    Swift

    func dictionaryValue() -> [String : Any]

    Return Value

    現在の設定条件のdictionary