Schema
と照合してXMLドキュメントをチェックするプロセッサです。
バリデータ・オブジェクトはスレッドセーフではなく、再入不可能です。 つまり、アプリケーション側で、どのような場合でも1つのValidator
オブジェクトが複数のスレッドから使用されることがないようにする必要があります。また、validate
メソッドが呼び出されている間、アプリケーションは再帰的にvalidate
メソッドを呼び出すことができません。
- 導入されたバージョン:
- 1.5
-
コンストラクタのサマリー
-
メソッドのサマリー
修飾子と型メソッド説明abstract ErrorHandler
このValidator
に設定されている現在のErrorHandler
を取得します。boolean
getFeature
(String name) 機能フラグの値を検索します。getProperty
(String name) プロパティ値を検索します。abstract LSResourceResolver
このValidator
に設定されている現在のLSResourceResolver
を取得します。abstract void
reset()
このValidator
を元の構成にリセットします。abstract void
setErrorHandler
(ErrorHandler errorHandler) validate
メソッドの呼出しで発生したエラーを受け取るようにErrorHandler
を設定します。void
setFeature
(String name, boolean value) 機能フラグの値を設定します。void
setProperty
(String name, Object object) プロパティ値を設定します。abstract void
setResourceResolver
(LSResourceResolver resourceResolver) 検証時のリソース解決をカスタマイズするようにLSResourceResolver
を設定します。void
指定された入力を検証します。abstract void
指定された入力を検証し、追加された検証結果を指定された出力に送ります。
-
コンストラクタの詳細
-
Validator
protected Validator()派生クラスのコンストラクタです。このコンストラクタは何も行いません。
派生クラスでは、
null
ErrorHandler
およびnull
LSResourceResolver
を持つValidator
オブジェクトを作成する必要があります。
-
-
メソッドの詳細
-
reset
public abstract void reset()このValidator
を元の構成にリセットします。Validator
は、Schema.newValidator()
で作成された時点の状態にリセットされます。reset()
は、既存のValidator
の再使用を許可するように設計されているため、新しいValidator
の作成に関連するリソースを節約できます。Validator
をリセットした場合、同じLSResourceResolver
またはErrorHandler
Object
(たとえば、Object.equals(Object obj)
)を持つことは保証されません。 機能的に同じLSResourceResolver
およびErrorHandler
を持つことは保証されます。 -
validate
public void validate(Source source) throws SAXException, IOException 指定された入力を検証します。これは
null
のresult
を持つvalidate(Source source, Result result)
の簡易メソッドです。- パラメータ:
source
- 検証されるXML。 XMLドキュメントまたはXML要素であることが必要でnullは不可。 下位互換性のために、ドキュメントと要素以外のすべての検証結果は実装に依存している。 実装は、入力を認識し処理するか、IllegalArgumentExceptionをスローする必要がある。- 例外:
IllegalArgumentException
-Source
が検証を実装できないXMLアーティファクトである場合(処理命令など)。SAXException
-ErrorHandler
がSAXException
をスローした場合、または致命的エラーが検出され、ErrorHandler
が正常に復帰した場合。IOException
- バリデータがSAXSource
を処理中で、ベースとなるXMLReader
がIOException
をスローした場合。NullPointerException
-source
がnull
の場合。- 関連項目:
-
validate
public abstract void validate(Source source, Result result) throws SAXException, IOException 指定された入力を検証し、追加された検証結果を指定された出力に送ります。このメソッドは受け付ける
Source
/Result
の型に関して、次の制約を設けています。受け付ける Source
/Result
StreamSource
SAXSource
DOMSource
StAXSource
null
OK OK OK OK StreamResult
OK IllegalArgumentException
IllegalArgumentException
IllegalArgumentException
SAXResult
IllegalArgumentException
OK IllegalArgumentException
IllegalArgumentException
DOMResult
IllegalArgumentException
IllegalArgumentException
OK IllegalArgumentException
StAXResult
IllegalArgumentException
IllegalArgumentException
IllegalArgumentException
OK 1つの
Source
を別の種類のResult
に検証するには、恒等変換を使用します(TransformerFactory.newTransformer()
を参照)。検証で発見されたエラーは指定された
ErrorHandler
に送られます。ドキュメントが有効である、またはドキュメントにいくらかのエラーがあるが、それらはすべて致命的でなく、
ErrorHandler
で例外がスローされていない場合、メソッドは正常に復帰します。- パラメータ:
source
- 検証されるXML。 XMLドキュメントまたはXML要素であることが必要でnullは不可。 下位互換性のために、ドキュメントと要素以外のすべての検証結果は実装に依存している。 実装は、入力を認識し処理するか、IllegalArgumentExceptionをスローする必要がある。result
- 拡張された可能性のあるXMLを受け取るResult
オブジェクト。 呼出し側で必要がなければ、このパラメータはnullも可。DOMResult
が使用され、バリデータがDOMSource
からDOMResult
へ同じDOMノードを渡すだけのときは(source.getNode()==result.getNode()
の場合)、DOMツリー全体がコピーされるか、ソースで指定されたノードが変更されることがある。- 例外:
IllegalArgumentException
-Result
タイプがSource
タイプと一致しない場合、またはSource
がXMLアーティファクトである場合は、実装では(たとえば、処理命令)を検証できません。SAXException
-ErrorHandler
がSAXException
をスローした場合、または致命的エラーが発見され、ErrorHandler
が正常に復帰した場合。IOException
- バリデータがSAXSource
を処理中で、ベースとなるXMLReader
がIOException
をスローした場合。NullPointerException
-source
パラメータがnull
である場合。- 関連項目:
-
setErrorHandler
public abstract void setErrorHandler(ErrorHandler errorHandler) validate
メソッドの呼出しで発生したエラーを受け取るようにErrorHandler
を設定します。エラー・ハンドラを使用して、検証時のエラー処理プロセスをカスタマイズできます。
ErrorHandler
を設定すると、検証で発見されたエラーはまずErrorHandler
に送られます。エラー・ハンドラはハンドラから
SAXException
をスローして、検証をただちに中断することができます。 または、エラーを画面に出力したり、ErrorHandler
から正常に戻って検証を続行させたりすることもできます。Throwable
がErrorHandler
からスローされると、validate
メソッドの呼出し元には同じThrowable
オブジェクトがスローされます。Validator
は、最初にErrorHandler
へ報告してからでないと、SAXException
をスローすることができません。ErrorHandler
がnullの場合、実装は次のErrorHandler
が設定されたかのように動作します。class DraconianErrorHandler implements
ErrorHandler
{ public void fatalError(SAXParseException
e ) throwsSAXException
{ throw e; } public void error(SAXParseException
e ) throwsSAXException
{ throw e; } public void warning(SAXParseException
e ) throwsSAXException
{ // noop } }新しい
Validator
オブジェクトが作成されると、最初にこのフィールドはnullに設定されます。- パラメータ:
errorHandler
- 設定する新しいエラー・ハンドラ。 このパラメータはnullも可。
-
getErrorHandler
public abstract ErrorHandler getErrorHandler()このValidator
に設定されている現在のErrorHandler
を取得します。- 戻り値:
- このメソッドは、
setErrorHandler(ErrorHandler)
メソッドによって最後に設定されたオブジェクトを返す。または、このValidator
が作成されてから、そのメソッドが呼び出されていない場合はnullを返す。 - 関連項目:
-
setResourceResolver
public abstract void setResourceResolver(LSResourceResolver resourceResolver) 検証時のリソース解決をカスタマイズするようにLSResourceResolver
を設定します。Validator
は、検証中に外部リソースの場所を確認する必要があるときにLSResourceResolver
を使用しますが、「外部リソースの検索」を厳密に構成するものはスキーマ言語により異なります。LSResourceResolver
がnullの場合、実装は次のLSResourceResolver
が設定されたかのように動作します。class DumbLSResourceResolver implements
LSResourceResolver
{ publicLSInput
resolveResource( String publicId, String systemId, String baseURI) { return null; // always return null } }LSResourceResolver
がRuntimeException
(またはその派生クラスのインスタンス)をスローすると、Validator
は構文解析を異常終了し、validate
メソッドの呼出し元は同じRuntimeException
を受け取ります。新しい
Validator
オブジェクトが作成されると、最初にこのフィールドはnullに設定されます。- パラメータ:
resourceResolver
- 設定する新しいリソース・リゾルバ。 このパラメータはnullも可。
-
getResourceResolver
public abstract LSResourceResolver getResourceResolver()このValidator
に設定されている現在のLSResourceResolver
を取得します。- 戻り値:
- このメソッドは、
setResourceResolver(LSResourceResolver)
メソッドによって最後に設定されたオブジェクトを返す。または、このValidator
が作成されてから、そのメソッドが呼び出されていない場合はnullを返す。 - 関連項目:
-
getFeature
public boolean getFeature(String name) throws SAXNotRecognizedException, SAXNotSupportedException 機能フラグの値を検索します。機能名は完全指定URIです。
Validator
は機能名を認識できますが、一時的にその値を返すことはできません。 機能の値によっては、検証の実行前、実行中、実行後などの特定のコンテキストでしか使用できない場合があります。独自のURIに基づいて作成された名前を使って、実装者が独自の機能を作成することもできます(推奨)。
- パラメータ:
name
- 機能名。null以外の完全指定URIで表される。- 戻り値:
- 機能の現在の値(trueまたはfalse)。
- 例外:
SAXNotRecognizedException
- 機能値を割り当てられない、または取得できない場合。SAXNotSupportedException
-Validator
が機能名を認識するだけで、現時点ではその値を判断できない場合。NullPointerException
- nameパラメータがnullである場合。- 関連項目:
-
setFeature
public void setFeature(String name, boolean value) throws SAXNotRecognizedException, SAXNotSupportedException 機能フラグの値を設定します。機能を使用して、
Validator
がスキーマを構文解析する方法を制御できますが、Validator
は特定の機能名を認識する必要はありません。機能名は完全指定URIです。
Validator
は機能の値を表示できますが、現在の値を変更することはできません。 機能の値によっては、検証の実行前、実行中、実行後などの特定のコンテキストでのみ不変または可変である場合があります。- パラメータ:
name
- 機能名。null以外の完全指定URIで表される。value
- 機能の要求された値(trueまたはfalse)。- 例外:
SAXNotRecognizedException
- 機能値を割り当てられない、または取得できない場合。SAXNotSupportedException
-Validator
が機能名を認識するだけで、要求された値を設定できない場合。NullPointerException
- nameパラメータがnullである場合。- 関連項目:
-
setProperty
public void setProperty(String name, Object object) throws SAXNotRecognizedException, SAXNotSupportedException プロパティ値を設定します。プロパティ名は完全指定URIです。
Validator
はプロパティ名を認識できますが、現在の値を変更することはできません。 プロパティの値によっては、検証の実行前、実行中、実行後などの特定のコンテキストでのみ不変または可変である場合があります。JAXP 1.5またはそれ以降を実装する実装はすべて、
XMLConstants.ACCESS_EXTERNAL_DTD
およびXMLConstants.ACCESS_EXTERNAL_SCHEMA
プロパティをサポートしている必要があります。-
ソースまたはスキーマ・ファイル内の外部DTDへのアクセスが、
XMLConstants.ACCESS_EXTERNAL_DTD
プロパティで指定されたプロトコルに制限されます。 このプロパティの制限が原因で検証中にアクセスが拒否された場合は、validate(Source)
メソッドによってSAXException
がスローされます。schemaLocation属性によって設定された外部参照へのアクセスが、
XMLConstants.ACCESS_EXTERNAL_SCHEMA
プロパティで指定されたプロトコルに制限されます。 このプロパティの制限が原因で検証中にアクセスが拒否された場合は、validate(Source)
メソッドによってSAXException
がスローされます。
- パラメータ:
name
- プロパティ名。null以外の完全指定URIで表される。object
- 要求されたプロパティ値。- 例外:
SAXNotRecognizedException
- プロパティ値を割り当てられない、または取得できない場合。SAXNotSupportedException
-Validator
がプロパティ名を認識するだけで、要求された値を設定できない場合。NullPointerException
- nameパラメータがnullである場合。
-
-
getProperty
public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException プロパティ値を検索します。プロパティ名は完全指定URIです。
Validator
はプロパティ名を認識できますが、一時的にその値を返すことはできません。 プロパティの値によっては、検証の実行前、実行中、実行後などの特定のコンテキストでしか使用できない場合があります。Validator
は特定のプロパティ名を認識する必要はありません。独自のURIに基づいて作成された名前を使って、実装者が独自のプロパティを作成することもできます(推奨)。
- パラメータ:
name
- プロパティ名。null以外の完全指定URIで表される。- 戻り値:
- 現在のプロパティ値。
- 例外:
SAXNotRecognizedException
- プロパティ値を割り当てられない、または取得できない場合。SAXNotSupportedException
- XMLReaderがプロパティ名を認識するだけで、現時点ではその値を判断できない場合。NullPointerException
- nameパラメータがnullである場合。- 関連項目:
-