クラス GridFsTemplate
java.lang.ObjectSE
org.springframework.data.mongodb.gridfs.GridFsTemplate
- 実装されているすべてのインターフェース:
ResourceLoader
、ResourcePatternResolver
、GridFsOperations
コンテンツを MongoDB GridFS に保存するための
GridFsOperations
実装。- 作成者:
- Oliver Gierke, Philipp Schneider, Thomas Darimont, Martin Baumgartner, Christoph Strobl, Mark Paluch, Hartmut Lang, Niklas Helge Hanft, Denis Zavedeev
フィールドのサマリー
インターフェース org.springframework.core.io.ResourceLoader から継承されたフィールド
CLASSPATH_URL_PREFIX
インターフェース org.springframework.core.io.support.ResourcePatternResolver から継承されたフィールド
CLASSPATH_ALL_URL_PREFIX
コンストラクターの概要
コンストラクターコンストラクター説明GridFsTemplate
(MongoConverter converter, SupplierSE<com.mongodb.client.gridfs.GridFSBucket> gridFSBucket) GridFsTemplate
(MongoDatabaseFactory dbFactory, MongoConverter converter) GridFsTemplate
(MongoDatabaseFactory dbFactory, MongoConverter converter, StringSE bucket) メソッドのサマリー
修飾子と型メソッド説明protected com.mongodb.client.gridfs.model.GridFSUploadOptions
computeUploadOptionsFor
(StringSE contentType, org.bson.Document metadata) 指定された contentType とメタデータDocument
から、使用するGridFSUploadOptions
を計算します。void
指定されたQuery
に一致するすべてのファイルを削除します。com.mongodb.client.gridfs.GridFSFindIterable
指定されたクエリに一致するすべてのファイルを返します。com.mongodb.client.gridfs.model.GridFSFile
指定されたクエリに一致する単一のGridFSFile
を返します。一致するファイルがない場合には null を返します。protected org.bson.Document
getMappedQuery
(org.bson.Document query) getResource
(com.mongodb.client.gridfs.model.GridFSFile file) GridFSFile
のGridFsResource
を返します。getResource
(StringSE location) 指定されたファイル名のGridFsResource
を返します。getResources
(StringSE locationPattern) 指定されたファイル名パターンに一致するすべてのGridFsResource
を返します。org.bson.types.ObjectId
store
(InputStreamSE content, StringSE filename, StringSE contentType, ObjectSE metadata) 指定されたメタデータを使用して、指定されたコンテンツを指定された名前とコンテンツ型でファイルに保存します。<T> T
store
(GridFsObject<T, InputStreamSE> upload) protected org.bson.Document
toDocument
(ObjectSE value) 指定された値をDocument
に変換します。
コンストラクターの詳細
GridFsTemplate
指定されたMongoDatabaseFactory
およびMongoConverter
を使用して、新しいGridFsTemplate
を作成します。GridFSBucket
はMongoDatabase
から 1 回だけ取得されることに注意してください。同じテンプレートインスタンスから異なるバケットを使用する場合は、GridFsTemplate(MongoConverter, Supplier)
を使用します。- パラメーター:
dbFactory
- null であってはなりません。converter
- null であってはなりません。
GridFsTemplate
public GridFsTemplate(MongoDatabaseFactory dbFactory, MongoConverter converter, @Nullable StringSE bucket) 指定されたMongoDatabaseFactory
およびMongoConverter
を使用して、新しいGridFsTemplate
を作成します。GridFSBucket
はMongoDatabase
から 1 回だけ取得されることに注意してください。同じテンプレートインスタンスから異なるバケットを使用する場合は、GridFsTemplate(MongoConverter, Supplier)
を使用します。- パラメーター:
dbFactory
- null であってはなりません。converter
- null であってはなりません。bucket
- null でもかまいません。
GridFsTemplate
public GridFsTemplate(MongoConverter converter, SupplierSE<com.mongodb.client.gridfs.GridFSBucket> gridFSBucket) - パラメーター:
converter
- null であってはなりません。gridFSBucket
- null であってはなりません。- 導入:
- 4.2
メソッドの詳細
store
public org.bson.types.ObjectId store(InputStreamSE content, @Nullable StringSE filename, @Nullable StringSE contentType, @Nullable ObjectSE metadata) インターフェースからコピーされた説明:GridFsOperations
指定されたメタデータを使用して、指定されたコンテンツを指定された名前とコンテンツ型でファイルに保存します。メタデータオブジェクトは書き込み前にマーシャリングされます。- 次で指定:
- インターフェース
GridFsOperations
のstore
- パラメーター:
content
- null であってはなりません。filename
- null または空であってはなりません。contentType
- null でもかまいません。metadata
- null でもかまいません- 戻り値:
- 先ほど作成した
GridFSFile
のObjectId
。
store
インターフェースからコピーされた説明:GridFsOperations
指定されたGridFsObject
(おそらくGridFsUpload
) を、指定されたname
を持つファイルに保存します。GridFsObject.getFileId()
が設定されている場合、ファイルはその ID で保存され、設定されていない場合はサーバーが自動的に新しい ID を作成します。- 次で指定:
- インターフェース
GridFsOperations
のstore
- 型パラメーター:
T
- 基礎となるGridFSFile
の ID 型- パラメーター:
upload
- 保存されるGridFsObject
(おそらくGridFsUpload
)。- 戻り値:
- 保存されたファイルの ID。自動作成された値または
GridFsObject.getFileId()
のいずれかですが、null にはなりません。
find
インターフェースからコピーされた説明:GridFsOperations
指定されたクエリに一致するすべてのファイルを返します。現在、Query
で定義されているSort
条件は、MongoDB が GridFS ファイルアクセスの順序付けをサポートしていないため、考慮されないことに注意してください。- 次で指定:
- インターフェース
GridFsOperations
のfind
- パラメーター:
query
- null であってはなりません。- 戻り値:
- 結果を取得するには
GridFSFindIterable
を使用します。例:MongoIterable.into(java.util.Collection)
を呼び出します。 - 関連事項:
findOne
インターフェースからコピーされた説明:GridFsOperations
指定されたクエリに一致する単一のGridFSFile
を返します。一致するファイルがない場合には null を返します。- 次で指定:
- インターフェース
GridFsOperations
のfindOne
- パラメーター:
query
- null であってはなりません。- 戻り値:
- null でもかまいません。
delete
インターフェースからコピーされた説明:GridFsOperations
指定されたQuery
に一致するすべてのファイルを削除します。- 次で指定:
- インターフェース
GridFsOperations
のdelete
- パラメーター:
query
- null であってはなりません。
getClassLoader
- 次で指定:
- インターフェース
ResourceLoader
のgetClassLoader
getResource
インターフェースからコピーされた説明:GridFsOperations
指定されたファイル名のGridFsResource
を返します。- 次で指定:
- インターフェース
GridFsOperations
のgetResource
- 次で指定:
- インターフェース
ResourceLoader
のgetResource
- パラメーター:
location
- null であってはなりません。- 戻り値:
- リソース。返された
GridFsResource
が実際に存在するかどうかを確認するには、Resource.exists()
を使用します。 - 関連事項:
getResource
インターフェースからコピーされた説明:GridFsOperations
GridFSFile
のGridFsResource
を返します。- 次で指定:
- インターフェース
GridFsOperations
のgetResource
- パラメーター:
file
- null であってはなりません。- 戻り値:
- ファイルのリソース。
getResources
インターフェースからコピーされた説明:GridFsOperations
指定されたファイル名パターンに一致するすべてのGridFsResource
を返します。- 次で指定:
- インターフェース
GridFsOperations
のgetResources
- 次で指定:
- インターフェース
ResourcePatternResolver
のgetResources
- パラメーター:
locationPattern
- null であってはなりません。- 戻り値:
- 何も見つからない場合は空の配列。
- 関連事項:
getMappedQuery
protected org.bson.Document getMappedQuery(org.bson.Document query) - パラメーター:
query
- 指定されたクエリをQueryMapper
に渡して型変換を適用します。- 戻り値:
- 決して null にはなりません。
computeUploadOptionsFor
protected com.mongodb.client.gridfs.model.GridFSUploadOptions computeUploadOptionsFor(@Nullable StringSE contentType, @Nullable org.bson.Document metadata) 指定された contentType とメタデータDocument
から、使用するGridFSUploadOptions
を計算します。- パラメーター:
contentType
- null でもかまいません。metadata
- null でもかまいません- 戻り値:
- 決して null にはなりません。
toDocument
指定された値をDocument
に変換します。- パラメーター:
value
- null でもかまいません。- 戻り値:
- ソース値が null の場合、空の
Document
になります。