Main Content

matlab.net.http.io.ImageProvider クラス

名前空間: matlab.net.http.io
スーパークラス: matlab.net.http.io.ContentProvider

MATLAB イメージ データを送信する ContentProvider

このページをすべて展開する

説明

ImageProvider オブジェクトは、HTTP RequestMessage で MATLAB® イメージ データを変換して送信する場合に使用します。このプロバイダーは、要求の Content-Type またはこのオブジェクトのプロパティで指定されたいずれかの標準の型にデータを変換します。さらに、このプロバイダーはイメージ ファイルを別の形式に変換します。

既定では、RequestMessage でイメージの Content-Type (たとえば "image/jpeg") を指定した場合、RequestMessage.Body の MessageBody にイメージ データが含まれていると、MessageBody.Data がイメージ データであると MATLAB で想定されて変換が試行されます。データの変換方法を制御するには、RequestMessage.Body で ImageProvider を使用します。

RequestMessage に Content-Type ヘッダー フィールドが含まれていない場合、このプロバイダーは該当するイメージの Content-Type をヘッダーに追加します。それ以外の場合は、Content-Type フィールドと値が一致しなくても、ヘッダー フィールドは変更されず、このオブジェクトのプロパティで指定された方法で変換が実行されます。

matlab.net.http.io.ImageProvider クラスは handle クラスです。

作成

説明

provider = ImageProvider(data,arg1,...,argN) は、MATLAB イメージ data を arg1,...,argN で指定された形式に変換するプロバイダーを作成し、Data プロパティを data、Arguments プロパティを arg1,...,argN に設定します。

provider = ImageProvider(filename,arg1,...,argN) は、ファイル filename からイメージ データを取得して arg1,...,argN または Content-Type フィールドで指定された形式で送信し、Filename プロパティを filename に設定します。

このプロバイダーではファイルを別の形式のデータに変換できますが、イメージ ファイルをそのままの形式で送信するようには設計されていません。ファイルのタイプを変更せずに送信するには、FileProvider を使用します。

プロパティ

すべて展開する

パブリック プロパティ

これは、コンストラクターの Data 引数で指定された値 (指定されている場合) か、filename 引数から変換されたデータになります。このプロバイダーを含むメッセージを送信する前に、この値を string スカラーまたは文字ベクトルに設定します。

サブクラスを作成する場合、MATLAB で start メソッドが呼び出される前にこのプロパティを設定するには、complete メソッドで値を設定します。このプロパティを変更した場合、変更内容は次の start の呼び出しから有効になります。

属性:

GetAccess
public
SetAccess
public

関数 imwrite に対する引数。cell 配列として指定します。これはコンストラクターに指定された値で、imwrite に対して記述された引数のリストが含まれますが、イメージ データとファイル名の引数は省かれています。

サブクラスを作成する際は、このプロパティを MATLAB で start が呼び出される前に complete などで設定できます。これらの値を変更した場合、変更内容は次の start の呼び出しから有効になります。

属性:

GetAccess
public
SetAccess
public
Dependent
true

イメージ データを含むファイルの名前。string として指定します。これは、コンストラクターの filename 引数で指定された値 (指定されている場合) になります。読み取り専用です。

filename の形式はファイル名拡張子から導出され、arg1,...,argN fmt 引数やメッセージの Content-Type とは異なる場合があります。このコンストラクターの構文では、特定の形式のイメージ ファイルを別の形式が想定されるサーバーに送信できます。ただし、互換性がないために変換できない場合もあります。たとえば、JPEG などの RGB ファイルを GIF 形式に変換することはできません。

属性:

GetAccess
public
SetAccess
private

メッセージまたはパートのヘッダー フィールド。1 つ以上の matlab.net.http.HeaderField オブジェクトのベクトルとして指定されます。

このプロパティはサブクラスの作成にのみ使用されます。このプロパティは、プロバイダーの complete を呼び出す前に MATLAB で設定されます。マルチパート メッセージ以外については、このプロパティは、MATLAB によって matlab.net.http.field.GenericFields や値が空のフィールドを除いた Request.Header の内容に初期化されます。ContentProvider では、送信するデータを示すヘッダー フィールドを追加したり、メッセージの既存のヘッダー フィールドにパラメーターを追加したりする場合にこのプロパティを使用します。MultipartProvider のデリゲートでは、このプロパティは、MATLAB によってデリゲート元のプロバイダーが挿入するパート用のヘッダー フィールドに初期化されます。これらのフィールドはデリゲートで変更が可能です。

マルチパート メッセージ以外では、プロバイダーの complete メソッドから戻ると、MATLAB はこのプロパティを読み取って、その内容を Request のヘッダーにマージします。この Header に含まれるフィールドの Names が Request.Header にない場合、Request.Header の末尾に追加されます。この Header に含まれるフィールドの Name が Request.Header に含まれるフィールドと同じで、どちらの Values も空でない場合は、次のように処理されます。

  • Request.Header のフィールドが GenericField の場合、Header のフィールドは無視されます。

  • Request.Header のフィールドが GenericField でない場合、Header のフィールドに置き換えられます。

これらの一方または両方の Value が空の場合は、Request.Header からフィールドが削除され、メッセージの正常な終了時にも追加されません。

MultipartProvider のデリゲートの場合は、この Header の内容全体がパートのヘッダーとして使用されます。マルチパート デリゲートでは、Request.Header にその Header に付随する任意のフィールドが含まれていると想定してはなりません。プロバイダーがマルチパート デリゲートであるかどうかは MyDelegator が MultipartProvider かどうかを確認すれば特定できますが、このテストが必要になることはほとんどありません。

このプロパティが MATLAB で読み取られるのは、プロバイダーの complete メソッドの呼び出しから戻るときだけです。MATLAB で start が呼び出された後は、この配列に対する変更は無視されます。

クラスを作成するときは、スーパークラスで complete を呼び出す前に、この (complete メソッド内の) Headerにサブクラスがフィールドを追加済みの場合があることを認識しておく必要があります。それらのフィールドは残しておいて、同じ名前のフィールドを追加しないようにすることを推奨します。ただし、フィールドへのパラメーターの追加は可能です。たとえば、既存の Content-Type フィールドに charset パラメーターがない場合、スーパークラスで追加できます。

属性:

GetAccess
public
SetAccess
public

チャンク転送コーディングを強制するかどうかを示します。boolean として指定されます。これはサブクラスの作成にのみ関係するプロパティで、マルチパート デリゲート以外のプロバイダーにのみ該当します。サブクラスでは、ForceChunked を設定することで、内容の送信にチャンク転送コーディングを使用するかどうかを制御します。false (既定) の場合、MATLAB は、メッセージの送信準備ができた時点で内容の長さがわかっているかどうかに基づいて、内容をチャンク化して送信するかどうかを決定します。

  • MATLAB で内容の長さがわかっている場合 (メッセージに Content-Length フィールドがあるか、このプロバイダーの expectedContentLength メソッドから数値が返された場合)、チャンク化して送信するかどうかを MATLAB で決定します。

  • MATLAB で内容の長さがわからない場合 (ヘッダーに Content-Length フィールドがないか、expectedContentLength の戻り値が空の場合)、MATLAB はメッセージを常にチャンク化して送信します。

ForceChunked が true の場合、内容の長さがわかっているかどうかに関係なく、既知の長さがチャンク サイズに満たない場合を除き、MATLAB はメッセージをチャンク化して送信します。このプロパティが true の場合は、メッセージに Content-Length フィールドを含めてはなりません。HTTP ではチャンクされたメッセージに Content-Length フィールドを含めることが許可されないためです。ただし、想定されるデータの長さを返しているかを MATLAB で検証する場合は、expectedContentLength メソッドで非ゼロの値を返すことができます。

MATLAB でメッセージをチャンク化して送信する場合、各チャンクのサイズは getData で返されたデータの長さと等しくなります。

MATLAB は、complete メソッドを呼び出してから start を呼び出すまでの間にこの値を読み取ります。このフィールドの設定は行いません。

属性:

GetAccess
public
SetAccess
public

送信する要求メッセージ。matlab.net.http.RequestMessage オブジェクトとして指定されます。

このプロパティはサブクラスの作成にのみ使用されます。このプロパティは、このプロバイダーで他のメソッドを呼び出す前であり、かつヘッダー フィールドを追加したりメッセージを検証したりする前に、このプロバイダーが Body に配置された RequestMessage に RequestMessage.send メソッドと RequestMessage.complete メソッドで設定されます。プロバイダーは、このメッセージを調べて元の要求の内容を確認できます。

デリゲートの場合、このプロパティの値はデリゲーターと同じになります。ContentProviders がデリゲートである場合は、必ずしも要求メッセージの本文全体を提供するわけではないため、この Request のヘッダー フィールドがそのプロバイダーで提供するデータに関連するものであるとは限らないことに注意が必要です。通常、デリゲートでは、この要求のデータ関連のヘッダー フィールド (Content-Type など) は無視します。

このメッセージへのヘッダー フィールドの追加や既存のヘッダー フィールドの変更をプロバイダーで行う場合は、complete メソッドで Header プロパティにそれらのフィールドを追加します。それらのフィールドに対する処理は、complete の呼び出し元 (RequestMessage またはデリゲート元のプロバイダー) で決定されます。RequestMessage.send と RequestMessage.complete は、それらのフィールドを RequestMessage の Header に常にコピーします。デリゲート元のプロバイダーでは、フィールドをそれぞれの Header プロパティにコピーしたりメッセージに挿入したりできます (MultipartProvider の場合と同様)。詳細については、Header プロパティを参照してください。

このプロパティは読み取り専用です。

属性:

GetAccesspublic
SetAccessmatlab.net.http.RequestMessage

保護プロパティ

このプロバイダーのデリゲート先の ContentProvider。matlab.net.http.io.ContentProvider オブジェクトとして指定されます。このプロパティは、現在のデリゲート先のプロバイダーを示すために呼び出し元のプロバイダー (デリゲーター) の delegateTo メソッドで設定されます。現在のデリゲーションがない場合、値は空です。

このプロパティは complete メソッドで空に設定されます。

属性:

GetAccess
protected
SetAccess
protected

このプロバイダーのデリゲート元の ContentProvider。matlab.net.http.io.ContentProvider オブジェクトとして指定されます。

このプロパティは、ContentProvider から別のプロバイダーにメッセージのすべてまたは一部のデータの送信がデリゲートされている場合に、デリゲート元のプロバイダーを示します。たとえば、MultipartProvider はメッセージのパートを他のプロバイダーにデリゲートするため、各デリゲートに自身のハンドルを挿入します。それ以外の場合、MyDelegator は空です。このプロパティは、デリゲートの delegateTo メソッドで設定されます。

属性:

GetAccess
protected
SetAccess
protected

メソッド

すべて展開する

詳細

すべて展開する

バージョン履歴

R2018a で導入

参考

| | | | |