com.pixelmed.validate
Class DicomSRValidator

java.lang.Object
  com.pixelmed.validate.DicomSRValidator

public class DicomSRValidator
extends Object

The DicomSRValidator class is for validating SR instances against the standard IOD for the corresponding SOP Class.

Typically used by reading the list of attributes that comprise an object, validating them and displaying the resulting string results to the user on the standard output, in a dialog box or whatever. The basic implementation of the main method (that may be useful as a command line utility in its own right) is as follows:

        AttributeList list = new AttributeList();
        list.read(arg[0],null,true,true);
        DicomSRValidator validator = new DicomSRValidator();
        System.err.print(validator.validate(list));
 

See Also:

AttributeList

Constructor Summary

DicomSRValidator()
Create an instance of validator.

Method Summary

static void	main(String[] arg) Read the DICOM file specified on the command line and validate it against the standard IOD for the appropriate storage SOP Class.
void	setOptionDescribeChecking(boolean option) Whether or not to describe the details of the validation procedure step by step.
void	setOptionMatchCaseOfCodeMeaning(boolean option) Whether or not to match the case of code meanings when validating them against the expected values in context groups and templates.
String	validate(AttributeList list) Validate a DICOM SR instance against the standard IOD for the appropriate SOP Class and templates.
String	validate(String filename) Validate a DICOM SR instance against the standard IOD for the appropriate SOP Class and templates.
protected String	validateFirstPass(Document inputDocument) Perform the first pass of the validation.
protected String	validateSecondPass(Document inputDocument, String firstOutputString) Perform the second pass of the validation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DicomSRValidator

public DicomSRValidator()
                 throws TransformerConfigurationException

Create an instance of validator.

Once created, a validator may be reused for as many validations as desired.

Throws:

TransformerConfigurationException

Method Detail

setOptionDescribeChecking

public void setOptionDescribeChecking(boolean option)

Whether or not to describe the details of the validation procedure step by step.

Default after construction is not to.

Parameters:

option - true if the steps are to be described

setOptionMatchCaseOfCodeMeaning

public void setOptionMatchCaseOfCodeMeaning(boolean option)

Whether or not to match the case of code meanings when validating them against the expected values in context groups and templates.

Default after construction is true, i.e., to be case sensitive.

Parameters:

option - true if matching is to be case sensitive

validateFirstPass

protected String validateFirstPass(Document inputDocument)
                            throws ParserConfigurationException,
                                   TransformerException,
                                   UnsupportedEncodingException

Perform the first pass of the validation.

Checks the document against the stylesheet and tracks which nodes matched templates.

Parameters:

inputDocument - the XML representation of the DICOM SR instance to be validated

Returns:

a string describing the results of the first pass of the validation

Throws:

ParserConfigurationException

TransformerException

UnsupportedEncodingException

validateSecondPass

protected String validateSecondPass(Document inputDocument,
                                    String firstOutputString)
                             throws ParserConfigurationException,
                                    TransformerException,
                                    UnsupportedEncodingException,
                                    IOException

Perform the second pass of the validation.

Checks for unused content items.

Parameters:

inputDocument - the XML representation of the DICOM SR instance to be validated

firstOutputString - the list of attributes comprising the DICOM SR instance to be validated

Returns:

a string describing the results of the validation

Throws:

ParserConfigurationException

TransformerException

UnsupportedEncodingException

IOException

validate

public String validate(AttributeList list)
                throws ParserConfigurationException,
                       TransformerException,
                       UnsupportedEncodingException,
                       IOException

Validate a DICOM SR instance against the standard IOD for the appropriate SOP Class and templates.

Parameters:

list - the list of attributes comprising the DICOM SR instance to be validated

Returns:

a string describing the results of the validation

Throws:

ParserConfigurationException

TransformerException

UnsupportedEncodingException

IOException

validate

public String validate(String filename)
                throws ParserConfigurationException,
                       TransformerException,
                       UnsupportedEncodingException,
                       IOException,
                       DicomException

Validate a DICOM SR instance against the standard IOD for the appropriate SOP Class and templates.

Parameters:

filename - the DICOM SR instance to be validated

Returns:

a string describing the results of the validation

Throws:

ParserConfigurationException

TransformerException

UnsupportedEncodingException

IOException

DicomException

main

public static void main(String[] arg)

Read the DICOM file specified on the command line and validate it against the standard IOD for the appropriate storage SOP Class.

The result of the validation is printed to the standard output.

Parameters:

arg - the name of the file containing the DICOM SR instance to be validated