ビューのエントリやナビゲータを処理する

ナビゲーションやアクセス用に、ビューやフォルダはビューエントリ、ビューエントリコレクション、ビューナビゲータをサポートします。

ビューのエントリ

ViewEntry オブジェクトはビュー内の行を表し、カテゴリ、文書、合計のどちらのタイプにもなれます。ViewEntry オブジェクトにアクセスするには、次のメソッドを使用します。

ViewNavigator メソッド (後述) は、View の getEntryByKey と同様に ViewEntry オブジェクトを返します。

ViewEntryCollection オブジェクトは、ゼロ個以上の文書タイプの ViewEntry オブジェクトを表します (タイプがカテゴリと合計であるエントリは除きます)。

getCount は、ビューエントリコレクション内のエントリ数を返します。getParent は、親の View オブジェクトを返します。getQuery は、コレクションが抽出されたものであるか、検査結果である場合に検索照会を返します。
FTSearch は、検索照会に一致するエントリだけが残るように、コレクションを抽出します。
getEntry、getNthEntry、getFirstEntry、getNextEntry、getLastEntry、getPrevEntry は、コレクションから ViewEntry オブジェクトを返します。
addEntry はコレクションにエントリを追加し、deleteEntry はコレクションからエントリを削除します。
removeAll は、データベースからビューエントリコレクションの要素となる文書をすべて削除します。stampAll は、すべての文書のアイテムに書き込みます。putAllInFolder は、すべての文書をフォルダに入れます。removeAllFromFolder は、フォルダからすべての文書を削除します。updateAll は、ビューエントリコレクションの全文書をエージェントにより処理済みとしてマークします。

View のメソッド getAllEntries と getAllEntriesByKey は、ViewEntryCollection オブジェクトを返します。

ViewNavigator オブジェクトは、ビューエントリでの位置を決める goto メソッドと、ビューエントリでの位置を決めてそれを返す両方を行う get メソッドを提供します。

gotoFirst、getFirst、gotoNext、getNext、gotoLast、getLast、gotoPrev、getPrev は、1 個ずつ順番にナビゲートします。
gotoFirstDocument、getFirstDocument、gotoNextCategory、getNextCategory、gotoNextDocument、getNextDocument、gotoLastDocument、getLastDocument、gotoPrevCategory、getPrevCategory、gotoPrevDocument、getPrevDocument は、エントリのタイプごとに順番にナビゲートします。
gotoEntry、getCurrent、getNth、gotoPos、getPos は、指定されたエントリにナビゲートします。
同様に、gotoNextSibling、getNextSibling、gotoPrevSibling、getPrevSibling、gotoChild、getChild、gotoParent、getParent は、親子階層をナビゲートします。
getCount は、ナビゲータによって表されるエントリ数を指定します。getMaxLevel と setMaxLevel は、ナビゲーションの最大レベル (0～30) を指定します。デフォルトは 30 です。getCacheSize と setCacheSize は、リモート操作の場合にのみキャッシュを指定します。getParentView は、親の View オブジェクトを取得します。

次の View のメソッドは ViewNavigator オブジェクトを作成します。ナビゲータは、メソッドの呼び出し元のビューに基づきます。