クラス 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
フィールド概要
インターフェース ResourceLoader から継承されたフィールド
CLASSPATH_URL_PREFIXインターフェース 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, @Nullable StringSE bucket) 方法の概要
修飾子と型メソッド説明protected com.mongodb.client.gridfs.model.GridFSUploadOptionscomputeUploadOptionsFor(@Nullable StringSE contentType, @Nullable org.bson.Document metadata) 指定された contentType とメタデータDocumentから、使用するGridFSUploadOptionsを計算します。void指定されたQueryに一致するすべてのファイルを削除します。com.mongodb.client.gridfs.GridFSFindIterable指定されたクエリに一致するすべてのファイルを返します。com.mongodb.client.gridfs.model.GridFSFile指定されたクエリに一致する単一のGridFSFileを返します。一致するファイルがない場合には null を返します。@Nullable ClassLoaderSEprotected org.bson.DocumentgetMappedQuery(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.ObjectIdstore(InputStreamSE content, @Nullable StringSE filename, @Nullable StringSE contentType, @Nullable ObjectSE metadata) 指定されたメタデータを使用して、指定されたコンテンツを指定された名前とコンテンツ型でファイルに保存します。<T> Tstore(GridFsObject<T, InputStreamSE> upload) protected org.bson.DocumenttoDocument(@Nullable 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
インターフェースからコピーされた説明:GridFsOperationsGridFSFileの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になります。