入力ノードの共通プロパティー
すべての入力ノードに共通するプロパティーを次に一覧にします。その後に、特定のノードに関する情報が続きます。
例 1
varfilenode = modeler.script.stream().create("variablefile", "Var. File")
varfilenode.setPropertyValue("full_filename", "$CLEO_DEMOS/DRUG1n")
varfilenode.setKeyedPropertyValue("check", "Age", "None")
varfilenode.setKeyedPropertyValue("values", "Age", [1, 100])
varfilenode.setKeyedPropertyValue("type", "Age", "Range")
varfilenode.setKeyedPropertyValue("direction", "Age", "Input")
例 2
このスクリプトは、指定されたデータ ファイルに、複数行の文字列を表す Region というフィールドが含まれていることを前提とします。
from modeler.api import StorageType
from modeler.api import MeasureType
# Create a Variable File node that reads the data set containing
# the "Region" field
varfilenode = modeler.script.stream().create("variablefile", "My Geo Data")
varfilenode.setPropertyValue("full_filename", "C:/mydata/mygeodata.csv")
varfilenode.setPropertyValue("treat_square_brackets_as_lists", True)
# Override the storage type to be a list...
varfilenode.setKeyedPropertyValue("custom_storage_type", "Region", StorageType.LIST)
# ...and specify the type if values in the list and the list depth
varfilenode.setKeyedPropertyValue("custom_list_storage_type", "Region", StorageType.INTEGER)
varfilenode.setKeyedPropertyValue("custom_list_depth", "Region", 2)
# Now change the measurement to indentify the field as a geospatial value...
varfilenode.setKeyedPropertyValue("measure_type", "Region", MeasureType.GEOSPATIAL)
# ...and finally specify the necessary information about the specific
# type of geospatial object
varfilenode.setKeyedPropertyValue("geo_type", "Region", "MultiLineString")
varfilenode.setKeyedPropertyValue("geo_coordinates", "Region", "2D")
varfilenode.setKeyedPropertyValue("has_coordinate_system", "Region", True)
varfilenode.setKeyedPropertyValue("coordinate_system", "Region",
"ETRS_1989_EPSG_Arctic_zone_5-47")
| プロパティー名 | データ型 | プロパティーの説明 |
|---|---|---|
direction |
Input
Target
Both
None
Partition
Split
頻度
RecordID |
フィールドの役割のキープロパティー。
使用形式 :
NODE.direction.FIELDNAME
注: 値
In と Out は廃止されました。今後のリリースではサポートが中断される場合があります。 |
type |
Range
Flag
Set
Typeless
Discrete
Ordered
Set
Default |
フィールドのデータ型。このプロパティーを Default に設定すると、values プロパティーに関するすべての値は消去され、value_mode を Specify に設定すると、それが Read にリセットされます。value_mode が Pass または Read がすでに設定されている場合、type の設定によって影響を受けることはありません。
使用形式 :
NODE.type.FIELDNAME |
storage |
Unknown
String
Integer
Real
Time
Date
Timestamp |
フィールドのストレージ・タイプ用読み込み専用キー・プロパティー。
使用形式 :
NODE.storage.FIELDNAME |
check |
None
Nullify
Coerce
Discard
Warn
Abort |
フィールド・タイプと範囲の検査用のキー・プロパティー。
使用形式 :
NODE.check.FIELDNAME |
values |
[値 値] | 連続型 (範囲) フィールドの場合、最初の値が最小値で最後の値が最大値になります。名義型 (セット型) フィールドの場合、すべての値を指定します。フラグ型の場合、最初の値が false (偽) を、最後の値が true (真) を表します。このプロパティーを設定すると、value_mode プロパティーの値が自動的に Specify に設定されます。ストレージは、リストの最初の値に基づいて決まります。例えば、最初の値が文字列 の場合、ストレージは String に設定されます。
使用形式 :
NODE.values.FIELDNAME
|
value_mode |
Read
Pass
Read+
Current
Specify
|
次のデータの受け渡し時にフィールドに値を
設定する方法を決定します。
使用形式 :
NODE.value_mode.FIELDNAME
このプロパティーに Specify を直接には設定できないことに注意してください。特定の値を使用するには、values プロパティーを設定します。 |
default_value_mode |
Read
Pass |
すべてのフィールドに値を設定するための
デフォルトの方法を指定します。
使用形式 :
NODE.default_value_mode
この設定による特定のフィールドの設定は、value_mode プロパティーを使用するとオーバーライドされることがあります。 |
extend_values |
フラグ | value_mode が Read に設定された場合に適用されます。新しく読み込んだ値を、フィールドの既存の値に追加する場合は、T を設定します。新しく読み込んだ値を優先して、既存の値を破棄する場合は、F を設定します。
使用形式 :
NODE.extend_values.FIELDNAME |
value_labels |
文字列 | 値ラベルの指定に使用します。数値を先に指定します。 |
enable_missing |
フラグ | T を設定した場合、フィールドの欠損値の追跡が有効になります。
使用形式 :
NODE.enable_missing.FIELDNAME |
missing_values |
[value value ...] | 欠損データを示すデータ値を指定します。
使用形式 :
NODE.missing_values.FIELDNAME |
range_missing |
フラグ | プロパティーが T に設定されている場合、フィールドに欠損値 (空白) の範囲が定義されているかどうかを指定します。
使用形式 :
NODE.range_missing.FIELDNAME |
missing_lower |
文字列 | range_missing が真 (true) の場合、欠損値範囲の下限値を指定します。
使用形式 :
NODE.missing_lower.FIELDNAME |
missing_upper |
文字列 | range_missing が真 (true) の場合、欠損値範囲の上限値を指定します。
使用形式 :
NODE.missing_upper.FIELDNAME |
null_missing |
フラグ | このプロパティーが T に設定されていると、ヌル (ソフトウェアでは $null$ として表示される未定義値) は欠損値と見なされます。
使用形式 :
NODE.null_missing.FIELDNAME |
whitespace_missing |
フラグ | このプロパティーが T に設定されていると、空白値 (スペース、タブ、および改行) だけを含む値は欠損値とみなされます。
使用形式 :
NODE.whitespace_missing.FIELDNAME |
description
|
文字列 | フィールドのラベルまたは説明の指定に使用します。 |
default_include |
フラグ | デフォルトの処理としてフィールドを通過させるかフィルターをかけるかの指定をするキー・プロパティー。
NODE.default_include
例:
set mynode:filternode.default_include
= false |
include |
フラグ | 各フィールドを適用するかフィルターをかけるかを決定するキー・プロパティー:
NODE.include.FIELDNAME. |
new_name
|
文字列 | |
measure_type
|
Range / MeasureType.RANGE
Discrete /
MeasureType.DISCRETE
Flag / MeasureType.FLAG
Set /
MeasureType.SET
OrderedSet /
MeasureType.ORDERED_SET
Typeless /
MeasureType.TYPELESS
Collection /
MeasureType.COLLECTION
Geospatial / MeasureType.GEOSPATIAL |
このキー付きプロパティーは、フィールドに関連付けられた尺度を定義するために使用できるという点で、type と類似しています。異なるのは、Python スクリプトで、getter 関数が常に MeasureType 値を返す一方で、setter 関数に MeasureType 値のうちの 1 つを渡すこともできるという点です。 |
collection_measure
|
Range / MeasureType.RANGE
Flag /
MeasureType.FLAG
Set / MeasureType.SET
OrderedSet /
MeasureType.ORDERED_SET
Typeless / MeasureType.TYPELESS |
収集フィールド (深さが 0 のリスト) の場合、このキー付きプロパティーは、基礎となる値に関連付けられた尺度タイプを定義します。 |
geo_type
|
Point
MultiPoint
LineString
MultiLineString
Polygon
MultiPolygon |
地理空間フィールドの場合、このキー付きプロパティーにより、このフィールドが表す地理空間オブジェクトのタイプが定義されます。これは、値のリストの深さと整合している必要があります。 |
has_coordinate_system
|
boolean | 地理空間フィールドの場合、このプロパティーにより、このフィールドに座標系があるかどうかが定義されます。 |
coordinate_system
|
文字列 | 地理空間フィールドの場合、このキー付きプロパティーにより、このフィールドの座標系が定義されます。 |
custom_storage_type
|
Unknown / MeasureType.UNKNOWN
String /
MeasureType.STRING
Integer /
MeasureType.INTEGER
Real / MeasureType.REAL
Time /
MeasureType.TIME
Date / MeasureType.DATE
Timestamp /
MeasureType.TIMESTAMP
List / MeasureType.LIST |
このキー付きプロパティーは、フィールドのオーバーライド ストレージを定義するために使用できるという点で、custom_storage と類似しています。異なるのは、Python スクリプトで、getter 関数が常に StorageType 値を返す一方で、setter 関数に StorageType 値のうちの 1 つを渡すこともできるという点です。 |
custom_list_storage_type
|
String / MeasureType.STRING
Integer /
MeasureType.INTEGER
Real / MeasureType.REAL
Time /
MeasureType.TIME
Date / MeasureType.DATE
Timestamp /
MeasureType.TIMESTAMP |
リスト フィールドの場合、このキー付きプロパティーにより、基礎となる値のストレージ タイプが指定されます。 |
custom_list_depth
|
整数 | リスト フィールドの場合、このキー付きプロパティーにより、フィールドの深さが指定されます。 |
max_list_length
|
整数 | 地理空間または集合のいずれかの尺度を持つデータのみに使用できます。リストの最大長を設定するには、リストに入れることができる要素の数を指定します。 |
max_string_length
|
整数 | データ型不明 のデータでのみ使用可能で、SQL を生成してテーブルを作成するときに使用されます。データの最大文字列の値を入力します。これにより、テーブルに生成される列が、その文字列を含めるのに十分な大きさになります。 |