一般的なプロパティ・パラメータ
ここでは、一般的なプロパティ・パラメータについて説明します。
概要
プロパティによっては、その動作に作用するように、そのプロパティのパラメータを指定できます。例えば、パラメータでは、最大値と最小値、表示に使用する形式、照合、特定のシナリオに使用する区切り文字などを指定できます。クラス定義内でパラメータを指定できます。以下に例を示します。
Property MyProperty as MyType (MYPARAMETER="some value");
主要なプロパティ・パラメータ
一部のパラメータは、あらゆるタイプのすべてのプロパティに使用できます。これらのパラメータは、以下のとおりです。
-
CALCSELECTIVITY — テーブル・チューニング機能でプロパティの selectivity を計算するかどうかを制御します。通常は、このパラメータを既定 (1) のままにしておくことが最良です。詳細は、"SQL 最適化ガイド" の “テーブルのチューニング” を参照してください。
-
CAPTION — クライアント・アプリケーションで、このプロパティに使用するキャプションです。
-
EXTERNALSQLNAME — リンク・テーブルで使用します。このパラメータでは、このプロパティのリンク先の外部テーブルにあるフィールドの名前を指定します。リンク・テーブル・ウィザードは、クラス生成時にこのパラメータをプロパティごとに指定します。リモート・データベースの SQL フィールドの名前は、さまざまな理由 (リモート・データベースのフィールド名が InterSystems IRIS の予約語であるなど) で InterSystems IRIS サーバ上のプロパティ名と異なる必要がある場合があります。リンク・テーブルの詳細は、"リンク・テーブル・ウィザード ： テーブルまたはビューへのリンク" を参照してください。
プロパティ・パラメータ EXTERNALSQLNAME には、SQLFieldName コンパイラ・キーワードとは別の用途があり、それらの項目には別の値を保持できます。SQLFieldName では、InterSystems IRIS データベース内の投影された SQL フィールド名を指定します。また、EXTERNALSQLNAME はリモート・データベース内のフィールド名です。
-
EXTERNALSQLTYPE — リンク・テーブルで使用します。このパラメータでは、このプロパティのリンク先の外部テーブルにあるフィールドの SQL タイプを指定します。リンク・テーブル・ウィザードは、クラス生成時にこのパラメータをプロパティごとに指定します。"EXTERNALSQLNAME" を参照してください。
-
JAVATYPE — このプロパティの投影先になる Java データ型です。
ほとんどのプロパティ・パラメータは、データ型クラスで定義されるため、クラス固有のものになります。次のセクションを参照してください。
クラス固有のプロパティ・パラメータ
このページの大半の部分では、すべてのプロパティで利用可能なパラメータについて説明します。その他の使用可能なパラメータは、プロパティで使用されるクラスによって異なります。ここでリストしたデータ型クラスがサポートするパラメータを以下のテーブルにリストします。パラメータは、3 つの列にグループ分けされています。1) 多くのデータ型クラスに存在するパラメータ、または頻繁に見かけるパラメータ。2) XML および SOAP のコンテキストでのみ意味を持つパラメータ。および 3) 少数のデータ型クラスにのみ出現するパラメータ、またはほとんど見かけないパラメータ。
| データ型クラス | 一般的なパラメータ | XML と SOAP のパラメータ | あまり一般的でないパラメータ |
|---|---|---|---|
| %BigIntOpens in a new tab | DISPLAYLIST、FORMAT、MAXVAL、MINVAL、VALUELIST | XSDTYPE | |
| %BinaryOpens in a new tab | MAXLEN、MINLEN | CANONICALXML、MTOM、XSDTYPE | |
| %BooleanOpens in a new tab | XSDTYPE | ||
| %CharOpens in a new tab | COLLATION、CONTENT、DISPLAYLIST、ESCAPE、MAXLEN、MINLEN、PATTERN、TRUNCATE、VALUELIST | XMLLISTPARAMETER、XSDTYPE | |
| %CounterOpens in a new tab | DISPLAYLIST、FORMAT、MAXVAL、MINVAL、VALUELIST | XSDTYPE | |
| %CurrencyOpens in a new tab* | DISPLAYLIST、FORMAT、MAXVAL、MINVAL、SCALE、VALUELIST | XSDTYPE | |
| %DateOpens in a new tab | DISPLAYLIST、FORMAT、MAXVAL、MINVAL、VALUELIST | XSDTYPE | |
| %DateTimeOpens in a new tab | DISPLAYLIST、MAXVAL、MINVAL、VALUELIST | XMLDEFAULTVALUE、XMLTIMEZONE、XSDTYPE | DATEFORMAT |
| %DecimalOpens in a new tab | DISPLAYLIST、FORMAT、MAXVAL、MINVAL、SCALE、VALUELIST | XSDTYPE | |
| %DoubleOpens in a new tab | DISPLAYLIST、FORMAT、MAXVAL、MINVAL、SCALE、VALUELIST | XSDTYPE | |
| %EnumStringOpens in a new tab | COLLATION、CONTENT、DISPLAYLIST、ESCAPE、MAXLEN、MINLEN、PATTERN、TRUNCATE、VALUELIST | XSDTYPE | |
| %ExactStringOpens in a new tab | COLLATION、CONTENT、DISPLAYLIST、ESCAPE、MAXLEN、MINLEN、PATTERN、TRUNCATE、VALUELIST | XSDLISTPARAMETER、XSDTYPE | |
| %IntegerOpens in a new tab | DISPLAYLIST、FORMAT、MAXVAL、MINVAL、VALUELIST | XSDTYPE | STRICT |
| %ListOpens in a new tab | ODBCDELIMITER | XSDTYPE | |
| %ListOfBinaryOpens in a new tab | ODBCDELIMITER | XSDTYPE | |
| %NameOpens in a new tab | COLLATION、MAXLEN | XSDTYPE | INDEXSUBSCRIPTS |
| %NumericOpens in a new tab | DISPLAYLIST、FORMAT、MAXVAL、MINVAL、SCALE、VALUELIST | XSDTYPE | |
| %PosixTimeOpens in a new tab | MAXVAL、MINVAL | XMLDEFAULTVALUE、XMLTIMEZONE、XSDTYPE | DATEFORMAT、INDEXNULLMARKER |
| %SmallIntOpens in a new tab | DISPLAYLIST、FORMAT、MAXVAL、MINVAL、VALUELIST | XSDTYPE | |
| %StatusOpens in a new tab | XSDTYPE | ||
| %StringOpens in a new tab | COLLATION、CONTENT、DISPLAYLIST、ESCAPE、MAXLEN、MINLEN、PATTERN、TRUNCATE、VALUELIST | XMLLISTPARAMETER、XSDTYPE | |
| %TimeOpens in a new tab | DISPLAYLIST、FORMAT、MAXVAL、MINVAL、VALUELIST | XMLTIMEZONE、XSDTYPE | PRECISION |
| %TimeStampOpens in a new tab | DISPLAYLIST、MAXVAL、MINVAL、VALUELIST | XMLDEFAULTVALUE、XMLTIMEZONE、XSDTYPE | |
| %TinyIntOpens in a new tab | DISPLAYLIST、FORMAT、MAXVAL、MINVAL、VALUELIST | XSDTYPE |
* この特殊な目的のクラスは、InterSystems IRIS への移行にのみ使用します。
制約という用語は、プロパティ値に制限を適用するキーワードを指します。例えば、MAXVAL、MINVAL、DISPLAYLIST、VALUELIST、および PATTERN は、すべて制約です。
一般的なパラメータ
前述のテーブルの一般的なパラメータを以下に示します。
-
COLLATION — プロパティ値がインデックスに変換される方法を指定します。
照合の許容値については、"SQL 入門" を参照してください。
-
CONTENT — 文字列が XML または HTML に変換される可能性があるコンテキストで使用される場合、その文字列のコンテンツを指定します。"STRING" (既定)、"ESCAPE"、または "MIXED" を指定します。
詳細は、"オブジェクトの XML への投影" を参照してください。
-
DISPLAYLIST — 列挙 (複数選択) プロパティのために、VALUELIST パラメータと併用します。詳細は、"列挙プロパティの定義" を参照してください。
-
ESCAPE — 文字列が特定のコンテキストで使用される場合に、エスケープを行うタイプを指定します。"XML" (既定) または "HTML" のいずれかを使用します。
既定では、小なり記号、大なり記号、およびアンド記号がそれぞれ <、>、および & に変換されます。"XML" の詳細は、"オブジェクトの XML への投影" を参照してください。
-
FORMAT — 表示値の形式を指定します。FORMAT の値については、$FNUMBER 関数の format 引数で指定した形式文字列を使用します。タイプ %NumericOpens in a new tab または %DecimalOpens in a new tab のプロパティの場合は、オプション "AUTO" も使用できます。このオプションは末尾のゼロを抑制します。
-
MAXLEN — 文字列の最大文字数を指定します。既定値は 50 です。また、このパラメータが "" である場合、長さは無制限になります。他の多くのパラメータと同様に、このパラメータは、InterSystems IRIS によるデータの検証方法に影響します。これは、フィールドがデータベース・ドライバ上でどのように投影されるかにも影響することに注意してください。
-
MAXVAL — データ型の論理値の最大値を指定します。
-
MINLEN — 文字列の最小文字数を指定します。
-
MINVAL — データ型の論理値の最小値を指定します。
-
ODBCDELIMITER — ODBC を使用して投影されるとき、%List 値の構成に使用する区切り文字を指定します。
-
PATTERN — 文字列がマッチするパターンを指定します。PATTERN の値は、有効な InterSystems IRIS パターン・マッチング式である必要があります。パターン・マッチングの概要は、"パターン・マッチング (?)" を参照してください。
-
SCALE — 小数点以下の桁数を指定します。
-
TRUNCATE — 文字列を MAXLEN の長さまで切り捨てるかどうかを指定します。1 は True で、0 は False です。このパラメータは、Normalize() メソッドと IsValid() メソッドによって使用されますが、データベース・ドライバには使用されません。
-
VALUELIST — 列挙 (複数選択) プロパティに使用します。詳細は、"列挙プロパティの定義" を参照してください。
XML と SOAP のパラメータ
XML と SOAP のパラメータの列にあるパラメータの詳細は、"オブジェクトの XML への投影" を参照してください。"Web サービスおよび Web クライアントの作成" も参照してください。
あまり一般的でないパラメータ
前述のテーブルの、あまり一般的でないパラメータを以下に示します。
-
STRICT (%IntegerOpens in a new tab の場合) には、整数の値が必要になります。既定では、プロパティが %IntegerOpens in a new tab 型の場合に、整数以外の数値を指定すると、InterSystems IRIS はその値を整数に変換します。プロパティに対して STRICT が 1 の場合には、InterSystems IRIS は値を変換せず、検証は失敗します。
-
DATEFORMAT.
-
%DateTimeOpens in a new tab の場合は、表示または ODBC 入力値に数値の日付形式が指定されているときに、このパラメータで日付部分の順序を指定します。有効なパラメータは mdy、dmy、ymd、ydm、myd、および dym です。 既定の DATEFORMAT は mdy です。
-
%PosixTimeOpens in a new tab の場合は、このパラメータで表示値の形式を指定します。許容される値については、$zdatetime 関数と $zdatetimeh 関数の fformat パラメータを参照してください。
-
-
PRECISION (%TimeOpens in a new tab の場合) では、保持する小数点以下の桁数を指定します。値が "" (既定) の場合、システムはソース値で入力された小数点以下桁数を保持します。値が 0 の場合、最も近い秒に丸められます。
-
INDEXNULLMARKER (%PosixTimeOpens in a new tab の場合のみ) では、%PosixTimeOpens in a new tab 型プロパティのインデックスの添え字に使用する、既定の NULL 指標値を宣言します。既定値は –1E19 です。"NULL のインデックス付け" を参照してください。
-
INDEXSUBSCRIPTS (%NameOpens in a new tab の場合) では、プロパティ値で区切り文字としてコンマを使用して、インデックス内のプロパティで使用される添え字の数を指定します。この数は、%Storage.Persistent クラスが使用します。2 の値は、プロパティ値の最初のコンマ部分は最初の添え字に、プロパティ値の 2 番目のコンマ部分は 2 番目の添え字に保存されることを示します。
