hiMongo.Collection

既知の実装クラスのリスト:

hiMongoCaller.Collection

含まれているクラス:

hiMongo
```
public static interface hiMongo.Collection
```
collectionを表す.
コレクション(collection)に対応します。

hiMongo.DB.in(String)によって得られます。
```
hiMongo.Collection coll=hiMongo.use("db01").in("coll_01");
```
find,update,replase機能など持ちます。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド
修飾子とタイプ	メソッドと説明
`hiMongo.Aggregator`	`aggregate()` aggregate(集計).
`hiMongo.Aggregator`	`aggregate(Object proc_)` aggregate(集計).
`hiMongo.DB`	`back()` DBに戻る.
`long`	`count()` レコード数を得る.
`long`	`count(Object filterJ_)` 条件に合致するレコード数を得る.
`hiMongo.Collection`	`createIndex(Object keyset_)` Index設定.
`hiMongo.Collection`	`createIndex(Object keyset_, Object option_)` Index設定.
`hiJSON.Engine`	`cur_engine()` 現状の解析/表示エンジンを得る(cloneではない)
`hiJSON.Engine`	`cur_engineJ()` 現状のJSON表示エンジンを得る(cloneではない)
`hiMongo.Collection`	`deleteMany(Object filterJ_)` 複数レコード削除.
`hiMongo.Collection`	`deleteOne(Object filterJ_)` １レコード削除.
`String`	`disp(String text_)` `hiMongo.Accessor.disp(String)`参照
`String`	`disp(String text_, long option_)` `hiMongo.Accessor.disp(String,long)`参照
`hiMongo.Collection`	`drop()` コレクションを削除します.
`hiMongo.Collection`	`dropIndex(String... index_)` index消去
`hiMongo.Collection`	`dropIndexes()` 全index消去.
`Object`	`eval(Object obj_)` {@link hi.db.hiMongo.Accessor#eval(Object)参照
`<T> T`	`eval(Object obj_, Class<T> class_)` `hiMongo.Accessor.eval(Object,Class)`参照
`<T> T`	`eval(Object obj_, T default_value_)` `Accessor#eval(Object,T)`参照
`hiMongo.Finder`	`find()` 全件検索のfind.
`hiMongo.Finder`	`find(Object filterJ_)` 検索条件指定のfind.
`hiMongo.Finder`	`find(Object filterJ_, Object memberJ_)` 検索条件とフィールド指定のfind.
`hiMongo.Collection`	`forThis(hiU.ConsumerEx<hiMongo.Collection,Exception> func_)` この集計器に対してラムダ式実行.
`Object`	`get_the_value()` `hiMongo.Accessor.get_the_value()`参照
`<T> T`	`get_the_value(Class<T> default_value_)` `hiMongo.Accessor.get_the_value(Class)`参照
`<T> T`	`get_the_value(T default_value_)` `hiMongo.Accessor.get_the_value(Object)`参照
`Object`	`get(String value_name_)` {@link hi.db.hiMongo.Accessor#get(String)参照
`<T> T`	`get(String value_name_, Class<T> class_)` {@link hi.db.hiMongo.Accessor#get(String,Class)参照
`<T> T`	`get(String value_name_, T default_value_)` `Accessor#eval(String,T)`参照
`ArrayList<Document>`	`getIndexList()` index情報のリストを得る.
`MongoCollection<Document>`	`getMongoCollection()` MongoCollectionを得る.
`Document`	`getValueAsDocument(String text_)` `hiMongo.Accessor.getValueAsDocument(String)`参照
`hiJSON.Probe`	`getValueAsProbe(String text_)` `hiMongo.Accessor.getValueAsProbe(String)`参照
`hiMongo.Collection`	`in(String collectionName_)` カレントDBでin実行(コレクションの切り替え).
`hiMongo.Collection`	`insertMany(Object... jsonTexts_)` リスト形式文字列で複数レコードを追加する.
`hiMongo.Collection`	`insertOne(Object... records_)` 1レコード追加(mongoAPIのinsertOne使用).
`String`	`name()` Collection名を得る
`hiJSON.Engine`	`parse_engine()` with_hsonパーズ用エンジン取得.
`hiMongo.Collection`	`replaceOne(Object filterJ_, Object recordJ_)` １レコード置換する.
`hiMongo.Collection`	`set_the_value(Object obj_)` `hi.db.hiMongo.Accessor#set_the_value(Object)`参照
`hiMongo.Collection`	`setValue(String name_, Object obj_)` `hiMongo.Finder.setValue(String,Object)`参照
`hiMongo.Collection`	`updateMany(Object filterJ_, Object updateJ_)` 条件に合うレコードを全てupdateする.
`hiMongo.Collection`	`updateOne(Object filterJ_, Object updateJ_)` 1レコードupdateする.
`hiMongo.Finder`	`withValue(String value_name_)` 指定変数をforEach解析対象とする.

- メソッドの詳細
  - getMongoCollection
```
MongoCollection<Document> getMongoCollection()
```
    MongoCollectionを得る.
    注意:driver直呼びでない場合はnullが返ります
    
    戻り値:
    
    driverのcollection構造体
  - parse_engine
```
hiJSON.Engine parse_engine()
```
    with_hsonパーズ用エンジン取得.
    
    戻り値:
    
    use_hsonの場合現状のエンジン、!use_hsonの場合null
  - cur_engine
```
hiJSON.Engine cur_engine()
```
    現状の解析/表示エンジンを得る(cloneではない)
    
    戻り値:
    
    解析/表示エンジン
  - cur_engineJ
```
hiJSON.Engine cur_engineJ()
```
    現状のJSON表示エンジンを得る(cloneではない)
    
    戻り値:
    
    解析/表示エンジン
  - back
```
hiMongo.DB back()
```
    DBに戻る.
    
    戻り値:
    
    このコレクションが属するデータベース
  - forThis
```
hiMongo.Collection forThis(hiU.ConsumerEx<hiMongo.Collection,Exception> func_)
```
    この集計器に対してラムダ式実行.
    
    パラメータ:
    
    func_ - Collectionを引数とするラムダ式
    
    戻り値:
    
    this
  - find
```
hiMongo.Finder find(Object filterJ_,
                    Object memberJ_)
```
    検索条件とフィールド指定のfind.
    このメソッドは条件設定を行います。実際の検索作業はforEachXXX(),getXXXList()時に行われます。
    
    引数は文字列(String),テキストファイル(File)またはノードツリー(node-Object:Document等)です。
    
    パラメータ:
    
    filterJ_ - jsonで条件指定
    
    memberJ_ - jsonで取得フィールド指定
    
    戻り値:
    
    Finder
  - find
```
hiMongo.Finder find(Object filterJ_)
```
    検索条件指定のfind.
    このメソッドは条件設定を行います。実際の検索作業はforEachXXX(),getXXXList()時に行われます。
    
    引数は文字列(String),テキストファイル(File)またはノードツリー(node-Object:Document等)です。
    
    パラメータ:
    
    filterJ_ - 条件指定
    
    戻り値:
    
    Finder
  - find
```
hiMongo.Finder find()
```
    全件検索のfind.
    このメソッドは条件設定を行います。実際の検索作業はforEachXXX(),getXXXList()時に行われます。
    
    戻り値:
    
    Finder
  - insertOne
```
hiMongo.Collection insertOne(Object... records_)
```
    1レコード追加(mongoAPIのinsertOne使用).
    レコードは拡張JSON、拡張JSONを内容とするテキストFile、拡張JSONの解析済みノードツリー、利用者クラスインスタンスが指定できます。
    
    パラメータ:
    
    records_ - レコード（通常mson文字列）。複数可
    
    戻り値:
    
    this
  - drop
```
hiMongo.Collection drop()
```
    コレクションを削除します.
    コレクションはDBから削除されますが連続してアクセスは可能です。
    insertが発行されれば現状の名前のコレクションが新たに生成されレコードが挿入されます。
```
hiMongo.use("db01")
       .in("coll_01")
       .drop()                             // コレクションが削除される
       .insertOne("{type:'A',value:1000}");// コレクションが生成され、レコードが追加される
```
    戻り値:
    
    this
  - count
```
long count()
```
    レコード数を得る.
    
    戻り値:
    
    レコード数
  - count
```
long count(Object filterJ_)
```
    条件に合致するレコード数を得る.
    findに与える条件と同等の条件を与え、該当レコードの個数を得ることが出来ます。
```
   hiMongo.DB db= hiMongo.use("testDB");
   System.out.println("count of type B|C = "+
        db.in("coll_01").count("{$or:[{type:'B'},{type:'C'}]}"));
```
    パラメータ:
    
    filterJ_ - 条件
    
    戻り値:
    
    レコード数
  - insertMany
```
hiMongo.Collection insertMany(Object... jsonTexts_)
```
    リスト形式文字列で複数レコードを追加する.
    レコードの単純並び形式の文字列でレコードを追加します。
    記述はJSONの配列形式("[{...},{...}...]")の形です。一個だけの記述("{...}")も許されます
    nsertMany()に配列または複数引数を与えることも可能です。
    
    レコードは拡張JSON、拡張JSONを内容とするテキストFile、拡張JSONの解析済みノードツリー、利用者クラスインスタンスのリストで指定します。
    一つのリストの中に複数の形式が混ざることは許されません。
```
   String _records=
        "[{type:'A',value:12.3,date:ISODate('2020-08-17T07:07:00.000Z')}"+
        ",{type:'A',value:4.56,date:ISODate('2020-08-17T07:07:10.000Z')}"+
        ",{type:'B',value:2001,date:ISODate('2020-08-17T07:07:20.000Z')}]";
   String _record2=
        "{type:'A',value:7.89,date:ISODate('2020-08-17T07:07:30.000Z')}";
   hiMongo.DB          db   =hiMongo.use("db02");
   hiMongo.Collection  _coll=db.in("coll_01");
   _coll.insertMany(_records,_records2); // 複数の文字列をセット可能
   db.close();
```
    コメントが入ったり配列形式でない形でレコードが並んでいる記述のファイルを読むことも出来ます。
```
＝＝＝ ファイル data.hson
  // 複数レコード記述が単純に並んでいる
  {type:'A',value:12.3,date:ISODate('2020-08-17T07:07:00.000Z')}
  {type:'A',value:/*4.56*/3.33,date:ISODate('2020-08-17T07:07:10.000Z')} // ブロックコメント
  {type:'B',value:2001,date:ISODate('2020-08-17T07:07:20.000Z')} // コメント
  {type:'A',value:7.89,date:ISODate('2020-08-17T07:07:30.000Z')}
＝＝＝ プログラム
   hiMongo.DB db= hiMongo.use("db01");
   db.in("coll_01").drop()
     .with_hson()
     .insertMany(new File("data.hson"));
```
    パラメータ:
    
    jsonTexts_ - json記述
    
    戻り値:
    
    this
  - aggregate
```
hiMongo.Aggregator aggregate(Object proc_)
```
    aggregate(集計).
    集計手続きを設定します。
    集計作業は集計器で行います。
    
    パラメータ:
    
    proc_ - 集計手続き [{...},{...}...]
    
    戻り値:
    
    集計器
  - aggregate
```
hiMongo.Aggregator aggregate()
```
    aggregate(集計).
    集計手続き無で集計器を作成します。
    集計手続きは集計器のmatch()メソッドなどで追加出来ます。
    
    戻り値:
    
    集計器
  - updateOne
```
hiMongo.Collection updateOne(Object filterJ_,
                             Object updateJ_)
```
    1レコードupdateする.
```
hiMongo.DB db=hiMongo.use("db01");
db.in("coll_01")
  .updateOne("{$and:[{type:'A'},{value:4.56}]}",
             "{$set:{value:0.15}}");
--- 対応するmongo-shell記述
use db01
db.coll_01.updateOne({$and:[{type:'A'},{value:4.56}]},
                    {$set:{value:0.15}});
```
    単純な値の置き換えを行う$setの他に値の増減を行う$incなども用意されています。 (更新の演算子参照)
    パラメータ:
    
    filterJ_ - 条件
    
    updateJ_ - 置き換えフィールド指定
    
    戻り値:
    
    this
  - updateMany
```
hiMongo.Collection updateMany(Object filterJ_,
                              Object updateJ_)
```
    条件に合うレコードを全てupdateする.
    引数は文字列(String),テキストファイル(File)またはノードツリー(node-Object:Document等)です。
```
hiMongo.DB db=hiMongo.use("db01");
db.in("coll_01")
  .updateMany("{$and:[{type:'A'},{value:{$lt:1.00}}]}}",
              "{$set:{value:1.00}}")
--- 対応するmongo-shell記述
use db01
db.coll_01.updateOne({$and:[{type:'A'},{value:{$lt:1.00}}]},
                     {$set:{value:1.00}});
```
    パラメータ:
    
    filterJ_ - 条件(String,File,node)
    
    updateJ_ - 置き換えフィールド指定(String,File,node)
    
    戻り値:
    
    this
  - replaceOne
```
hiMongo.Collection replaceOne(Object filterJ_,
                              Object recordJ_)
```
    １レコード置換する.
    条件に合致するレコードを１個だけ置き換えます。
    
    レコードは拡張JSON、拡張JSONを内容とするテキストFile、拡張JSONの解析済みノードツリー、利用者クラスインスタンスで指定します。
    
    パラメータ:
    
    filterJ_ - 条件
    
    recordJ_ - 新規レコード内容
    
    戻り値:
    
    this
  - deleteOne
```
hiMongo.Collection deleteOne(Object filterJ_)
```
    １レコード削除.
    条件に合致するレコードを１個だけ削除。
    
    パラメータ:
    
    filterJ_ - 条件
    
    戻り値:
    
    this
  - deleteMany
```
hiMongo.Collection deleteMany(Object filterJ_)
```
    複数レコード削除.
    条件に合致するレコードを１個だけ削除。
    
    パラメータ:
    
    filterJ_ - 条件
    
    戻り値:
    
    this
  - createIndex
```
hiMongo.Collection createIndex(Object keyset_,
                               Object option_)
```
    Index設定.
    指定フィールドにindexを付加します。
    
    keyset_にはフィールド名と昇順(-1)、降順(1)の指定を行います。昇順/降順の違いは気にする必要はほぼ有りません。
    
    option_にはJSONデータで{}{unique:true}{expireAfter:秒数}を設定します。
    {unique:true}を設定すると、そのフィールドはユニーク値を持つものとなり、同値の別レコードのinsertはエラーとなります。
    {expireAfter:秒数}を設定すると、指定秒数を超えたレコードは削除されます。
    {expireAfterMinutes:分},{expireAfterHours:時},{expireAfterDays:日}の指定も可能です。 IndexOptionsを直接置くことも出来ます。
    
    パラメータ:
    
    keyset_ - フィールドと昇順降順指定のセット
    
    option_ - {}{unique:true}{expireAfter:秒数}
    
    戻り値:
    
    this
  - createIndex
```
hiMongo.Collection createIndex(Object keyset_)
```
    Index設定.
    
    パラメータ:
    
    keyset_ - キーと昇順降順指定のセット
    
    戻り値:
    
    this
  - dropIndexes
```
hiMongo.Collection dropIndexes()
```
    全index消去.
    
    戻り値:
    
    this
  - dropIndex
```
hiMongo.Collection dropIndex(String... index_)
```
    index消去
    
    戻り値:
    
    this
  - getIndexList
```
ArrayList<Document> getIndexList()
```
    index情報のリストを得る.
    
    戻り値:
    
    リスト
  - in
```
hiMongo.Collection in(String collectionName_)
```
    カレントDBでin実行(コレクションの切り替え).
    
    パラメータ:
    
    collectionName_ - コレクション名
    
    戻り値:
    
    コレクション
  - name
```
String name()
```
    Collection名を得る
    
    戻り値:
    
    collection名
  - withValue
```
hiMongo.Finder withValue(String value_name_)
```
    指定変数をforEach解析対象とする.
    指定変数をfind結果の代わりに解析対象とします。
```
hiMongo.DB db= hiMongo.use("db01")
db.setValue("#TEMP","[{type:'X',value:1},{type:'Y',value:13},{type:'Z',value:11}]");
  .withValue("#TEMP")
  .forEachMson(Rm->System.out.println(Rm)) //type'X'～'Z'のレコードが表示される
```
    パラメータ:
    
    value_name_ - 変数名
    
    戻り値:
    
    this;
  - setValue
```
hiMongo.Collection setValue(String name_,
                            Object obj_)
```
    hiMongo.Finder.setValue(String,Object)参照
  - get
```
Object get(String value_name_)
```
    {@link hi.db.hiMongo.Accessor#get(String)参照
  - get
```
<T> T get(String value_name_,
          T default_value_)
```
    Accessor#eval(String,T)参照
  - get
```
<T> T get(String value_name_,
          Class<T> class_)
```
    {@link hi.db.hiMongo.Accessor#get(String,Class)参照
  - eval
```
Object eval(Object obj_)
```
    {@link hi.db.hiMongo.Accessor#eval(Object)参照
  - eval
```
<T> T eval(Object obj_,
           T default_value_)
```
    Accessor#eval(Object,T)参照
  - eval
```
<T> T eval(Object obj_,
           Class<T> class_)
```
    hiMongo.Accessor.eval(Object,Class)参照
  - disp
```
String disp(String text_)
```
    hiMongo.Accessor.disp(String)参照
  - disp
```
String disp(String text_,
            long option_)
```
    hiMongo.Accessor.disp(String,long)参照
  - set_the_value
```
hiMongo.Collection set_the_value(Object obj_)
```
    hi.db.hiMongo.Accessor#set_the_value(Object)参照
  - get_the_value
```
Object get_the_value()
```
    hiMongo.Accessor.get_the_value()参照
  - get_the_value
```
<T> T get_the_value(T default_value_)
```
    hiMongo.Accessor.get_the_value(Object)参照
  - get_the_value
```
<T> T get_the_value(Class<T> default_value_)
```
    hiMongo.Accessor.get_the_value(Class)参照
  - getValueAsDocument
```
Document getValueAsDocument(String text_)
```
    hiMongo.Accessor.getValueAsDocument(String)参照
  - getValueAsProbe
```
hiJSON.Probe getValueAsProbe(String text_)
```
    hiMongo.Accessor.getValueAsProbe(String)参照

インタフェース hiMongo.Collection

メソッドのサマリー

メソッドの詳細

getMongoCollection

parse_engine

cur_engine

cur_engineJ

back

forThis

find

find

find

insertOne

drop

count

count

insertMany

aggregate

aggregate

updateOne

updateMany

replaceOne

deleteOne

deleteMany

createIndex

createIndex

dropIndexes

dropIndex

getIndexList

in

name

withValue

setValue

get

get

get

eval

eval

eval

disp

disp

set_the_value

get_the_value

get_the_value

get_the_value

getValueAsDocument

getValueAsProbe