延伸資料元素說明是 ExtendedDataElementDescription 的類別的一個實例。
執行這項作業的原因和時機
如果要將延伸資料元素說明新增至事件定義中,您必須先建立新的延伸資料元素說明,然後再設定其欄位的值。您也可以新增巢狀(子項)延伸資料元素說明來說明巢狀延伸資料元素。
然後您就可以新增延伸資料元素說明至事件定義中。
這項作業的步驟
- 如果要建立新的延伸資料元素說明,請指定延伸資料元素的名稱和類型,
來建立 ExtendedDataElementDescription 的實例。
ExtendedDataElementDescription edeDesc =
new ExtendedDataElementDescription(name, type);
這個建構子的參數如下:- name
- 延伸資料元素的名稱。這必須是您要說明之延伸資料元素的 name 內容值。
- type
- 延伸資料元素的資料類型。這必須是 org.eclipse.hyades.logging.events.cbe.ExtendedDataElement 類別所定義的下列其中一個整數常數:
- TYPE_BOOLEAN_ARRAY_VALUE
- TYPE_BOOLEAN_VALUE
- TYPE_BYTE_ARRAY_VALUE
- TYPE_BYTE_ARRAY
- TYPE_DATE_TIME_ARRAY_VALUE
- TYPE_DATE_TIME_VALUE
- TYPE_DOUBLE_ARRAY_VALUE
- TYPE_DOUBLE_VALUE
- TYPE_FLOAT_ARRAY_VALUE
- TYPE_FLOAT_VALUE
- TYPE_HEX_BINARY_VALUE
- TYPE_INT_ARRAY_VALUE
- TYPE_INT_VALUE
- TYPE_LONG_ARRAY_VALUE
- TYPE_LONG_VALUE
- TYPE_NO_VALUE_VALUE
- TYPE_SHORT_ARRAY_VALUE
- TYPE_SHORT_VALUE
- TYPE_STRING_ARRAY_VALUE
- TYPE_STRING_VALUE
傳回的物件是新的 ExtendedDataElementDescription 物件。
- 移入延伸資料元素說明的欄位。 ExtendedDataElementDescription 類別對延伸資料元素說明中的每一個欄位提供 setter 方法。請參閱 Javadoc API 文件,
以取得這些方法的完整資訊。 比方說,如果要指定延伸資料元素必須至少出現一次,您可以利用 setMaxOccurs(int) 方法,
將 maxOccurs 內容設為 4:
edeDesc.setMaxOccurs(4);
- 選擇性的: 如果要新增子項延伸資料元素說明,請使用 ExtendedDataElementDescription.addChild() 方法。
edeDesc.addChild(childEdeDesc);
childEdeDesc 參數必須是有效的延伸資料元素說明。
- 利用 EventDefinition.addExtendedDataElementDescription() 方法,將延伸資料元素說明新增至事件定義中。
definition.addExtendedDataElementDescription(edeDesc);
如果事件定義中已用相同名稱和路徑併入另一個延伸資料元素說明,
則擲出 DescriptionExistsException 異常狀況。
範例
下列程式碼片段會建立新的延伸資料元素說明、移入資料,並將它新增至事件定義中。
ExtendedDataElementDescription edeDesc =
new ExtendedDataElementDescription("age", TYPE_SHORT_VALUE);
edeDesc.setMinOccurs(1);
edeDesc.setMaxOccurs(1);
// 定義是有效的事件定義
definition.addExtendedDataElementDescription(edeDesc);