NBQuery

@interface NBQuery : NSObject

Queryクラス

検索条件を集約するクラス。NBObjectの検索に使用する。

  • 検索上限数

    設定可能な範囲は0〜100。未設定の場合は条件を設定しない。 0未満の場合は未設定と見なす。

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSInteger limit;

    Swift

    var limit: Int { get set }

  • スキップカウント

    スキップカウントの有効範囲は0以上の値とする。 0未満の場合は未設定と見なす。

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSInteger skip;

    Swift

    var skip: Int { get set }

  • 検索条件に合致した件数

    YES: 件数取得を行う (初期値) NO: 件数取得を行わない

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL queryCount;

    Swift

    var isQueryCount: Bool { get set }

  • 検索条件とするNBClause

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, nullable) NBClause *clause;

    Swift

    var clause: NBClause? { get set }

  • NBClauseの条件を設定したNBQueryを生成する。

    Declaration

    Objective-C

    + (nonnull NBQuery *)queryWithClause:(nonnull NBClause *)clause;

    Swift

    /*not inherited*/ init(clause: NBClause)

    Parameters

    clause

    Queryに設定する検索条件

    Return Value

    NBQueryのインスタンス

  • ソート条件設定

    複数のキーを設定した場合、設定順にソートを行う

    Declaration

    Objective-C

    - (void)setSortOrderWithKey:(nonnull NSString *)key isAscend:(BOOL)sortOrder;

    Swift

    func setSortOrder(key: String, isAscend sortOrder: Bool)

    Parameters

    key

    ソート条件とするフィールド
    sortOrder

    YES: 昇順 NO: 降順

  • ソート条件取得

    設定されているソート条件を取得する

    Declaration

    Objective-C

    - (nonnull NSArray<NSString *> *)sortOrder;

    Swift

    func sortOrder() -> [String]

    Return Value

    ソート条件　配列にはNSDictionary型の要素を格納する 複数のソート条件を設定した場合は設定順に配列に格納されてる。 フィールド名をキーに昇順、降順のパラメータが取得可能。