LIXM 1.6.1M5

org.lixm.optional.v15.atattch
インタフェース LIXMConfigurationSupport


public interface LIXMConfigurationSupport

XMLModelaizer実装 やXMLDocumentList実装 の構成の設定および取得をサポートする為のインターフェイスです。

このインターフェイスの実装されたオブジェクトを構成情報と呼びます。

構成の状態はこのインターフェイスの実装クラスが持ち全く同じ構成を利用する構成対象は 使い回しが可能です。
変更可能な構成の種類には機能特性 があり機能とは主にモデライザのモード変更、 特性は主にディスパッチャとレシーバの動作変更を可能とします。

機能と特性は任意の有効な絶対URI文字列を識別子として利用します。

機能と特性

機能は主にモデライザのXML文書解析時のパーサーモードに影響を与えます。
その結果、同じモデライザでも利用する構成が違うと異なるモデルリストを生成します。

特性は主にモデルリストのディスパッチ時やレシーブ時の挙動に影響を与えます。
特性は利用可能なディスパッチフィルタや特殊なレシーブアクションといったものです。

機能の場合と同様、 同じモデルリストでも利用する構成が違うと異なるモデルリストを生成します。

LIXMには標準的に定義している機能や特性はありません。
ただし、将来別の手段で有効な構成セットを提供する可能性は十分にあります。

導入されたバージョン:
1.5
バージョン:
1.6.1
作成者:
tasogare

メソッドの概要
 boolean getFeature(java.lang.String name)
          機能フラグを取得します。
 java.lang.String[] getFeatureSupports()
          サポートされる全機能の取得。
 java.lang.Object getProperty(java.lang.String name)
          特性を取得します。
 java.lang.String[] getPropertySupports()
          サポートされる全特性の取得。
 void setFeature(java.lang.String name, boolean value)
          機能フラグを設定します。
 void setProperty(java.lang.String name, java.lang.Object value)
          特性を設定します。
 

メソッドの詳細

getFeature

boolean getFeature(java.lang.String name)
                   throws LIXMConfigurationException

機能フラグを取得します。機能名は絶対URIです。
機能によっては特定のコンテキスト下でなければ取得できない場合があります。

そのような場合と無効な機能フラグを取得しようとした場合は LIXMConfigurationExceptionが投げられます。

パラメータ:
name - 機能フラグ名。有効な絶対URI文字列
戻り値:
真偽値で表現される機能フラグの値
例外:
LIXMConfigurationException - 不正なフラグ操作や無効なフラグを取得しようとした場合

setFeature

void setFeature(java.lang.String name,
                boolean value)
                throws LIXMConfigurationException

機能フラグを設定します。機能名は絶対URIです。
機能によっては特定のコンテキスト下でなければ設定できない場合があります。

そのような場合と無効な機能フラグを設定しようとした場合は LIXMConfigurationExceptionが投げられます。

パラメータ:
name - 機能名。有効な絶対URI文字列
value - フラグの値
例外:
LIXMConfigurationException - 不正なフラグ操作や無効なフラグを設定しようとした場合

getFeatureSupports

java.lang.String[] getFeatureSupports()

サポートされる全機能の取得。ここにある全ての機能のみが有効となる。

戻り値:
有効な全ての機能名

getPropertySupports

java.lang.String[] getPropertySupports()

サポートされる全特性の取得。ここにある全ての特性のみが有効となる。

戻り値:
有効な全ての特性名

getProperty

java.lang.Object getProperty(java.lang.String name)
                             throws LIXMConfigurationException

特性を取得します。特性名は絶対URIです。
特性によっては特定のコンテキスト下でなければ取得できない場合があります。

そのような場合と無効な特性を取得しようとした場合は LIXMConfigurationExceptionが投げられます。

パラメータ:
name - 特性名。有効な絶対URI文字列
戻り値:
特性オブジェクト
例外:
LIXMConfigurationException - 不正な特性操作や無効な特性を取得しようとした場合

setProperty

void setProperty(java.lang.String name,
                 java.lang.Object value)
                 throws LIXMConfigurationException

特性を設定します。特性名は絶対URIです。
特性によっては特定のコンテキスト下でなければ設定できない場合があります。

そのような場合と無効な特性を設定しようとした場合は LIXMConfigurationExceptionが投げられます。

パラメータ:
name - 特性名。有効な絶対URI文字列
value - 特性オブジェクト
例外:
LIXMConfigurationException - 不正な特性操作や無効な特性を設定しようとした場合

LIXM 1.6.1M5

Copyright © 2005-2007 tasogare. All rights reserved.