public class DicomSRValidator
extends java.lang.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));
AttributeList
Constructor and Description |
---|
DicomSRValidator()
Create an instance of validator.
|
Modifier and Type | Method and Description |
---|---|
static void |
main(java.lang.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 |
setOptionCheckAmbiguousTemplate(boolean option)
Whether or not to check and warn about ambiguous inclusion of templates (different templates match same content).
|
void |
setOptionCheckContentItemOrder(boolean option)
Whether or not to check and warn about content item order not matching order in templates.
|
void |
setOptionCheckTemplateID(boolean option)
Whether or not to check if encoded Template ID on CONTAINERs match expected template.
|
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.
|
java.lang.String |
validate(AttributeList list)
Validate a DICOM SR instance against the standard IOD for the appropriate SOP Class and templates.
|
java.lang.String |
validate(AttributeList list,
boolean describe,
boolean matchCase,
boolean checkAmbiguousTemplate,
boolean checkContentItemOrder,
boolean checkTemplateID)
Validate a DICOM SR instance against the standard IOD for the appropriate SOP Class and templates.
|
java.lang.String |
validate(java.lang.String filename)
Validate a DICOM SR instance against the standard IOD for the appropriate SOP Class and templates.
|
java.lang.String |
validate(java.lang.String filename,
boolean describe,
boolean matchCase,
boolean checkAmbiguousTemplate,
boolean checkContentItemOrder,
boolean checkTemplateID)
Validate a DICOM SR instance against the standard IOD for the appropriate SOP Class and templates.
|
protected java.lang.String |
validateFirstPass(org.w3c.dom.Document inputDocument)
Perform the first pass of the validation.
|
protected java.lang.String |
validateSecondPass(org.w3c.dom.Document inputDocument,
java.lang.String firstOutputString)
Perform the second pass of the validation.
|
public DicomSRValidator() throws javax.xml.transform.TransformerConfigurationException
Create an instance of validator.
Once created, a validator may be reused for as many validations as desired.
javax.xml.transform.TransformerConfigurationException
public static void main(java.lang.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.
arg
- optionally -describe, -donotmatchcase, -checkambiguoustemplate, -checkcontentitemorder, -checktemplateid, then the name of the file containing the DICOM SR instance to be validatedpublic void setOptionCheckAmbiguousTemplate(boolean option)
Whether or not to check and warn about ambiguous inclusion of templates (different templates match same content).
Default after construction is false, i.e., not to check.
option
- true if checkingpublic void setOptionCheckContentItemOrder(boolean option)
Whether or not to check and warn about content item order not matching order in templates.
The check is irrespective of whether order deemed significant in template definition.
May emit spurious warnings if template invocation is ambiguous (different templates match same content) and content item order is different in any of the matching templates.
Default after construction is false, i.e., not to check.
option
- true if checkingpublic void setOptionCheckTemplateID(boolean option)
Whether or not to check if encoded Template ID on CONTAINERs match expected template.
May emit spurious warnings if template invocation is ambiguous (different templates match same content).
The explicitly encoded Template ID is NOT used to constrain template matching.
Default after construction is false, i.e., not to check.
option
- true if checkingpublic void setOptionDescribeChecking(boolean option)
Whether or not to describe the details of the validation procedure step by step.
Default after construction is not to.
option
- true if the steps are to be describedpublic 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.
option
- true if matching is to be case sensitivepublic java.lang.String validate(AttributeList list) throws javax.xml.parsers.ParserConfigurationException, javax.xml.transform.TransformerException, java.io.UnsupportedEncodingException, java.io.IOException
Validate a DICOM SR instance against the standard IOD for the appropriate SOP Class and templates.
Does not describe the details of the validation procedure step by step, and does match the case of code meanings when validating them against the expected values in context groups and templates.
list
- the list of attributes comprising the DICOM SR instance to be validatedjavax.xml.parsers.ParserConfigurationException
javax.xml.transform.TransformerException
java.io.UnsupportedEncodingException
java.io.IOException
public java.lang.String validate(AttributeList list, boolean describe, boolean matchCase, boolean checkAmbiguousTemplate, boolean checkContentItemOrder, boolean checkTemplateID) throws javax.xml.parsers.ParserConfigurationException, javax.xml.transform.TransformerException, java.io.UnsupportedEncodingException, java.io.IOException
Validate a DICOM SR instance against the standard IOD for the appropriate SOP Class and templates.
list
- the list of attributes comprising the DICOM SR instance to be validateddescribe
- whether or not to describe the details of the validation procedure step by stepmatchCase
- whether or not to match the case of code meanings when validating them against the expected values in context groups and templatescheckAmbiguousTemplate
- whether or not to check and warn about ambiguous inclusion of templates (different templates match same content)checkContentItemOrder
- whether or not to check and warn about content item order not matching order in templates (irrespective of whether order deemed significant in template definition)checkTemplateID
- whether or not to check if encoded Template ID on CONTAINERs match expected templatejavax.xml.parsers.ParserConfigurationException
javax.xml.transform.TransformerException
java.io.UnsupportedEncodingException
java.io.IOException
public java.lang.String validate(java.lang.String filename) throws javax.xml.parsers.ParserConfigurationException, javax.xml.transform.TransformerException, java.io.UnsupportedEncodingException, java.io.IOException, DicomException
Validate a DICOM SR instance against the standard IOD for the appropriate SOP Class and templates.
Does not describe the details of the validation procedure step by step, and does match the case of code meanings when validating them against the expected values in context groups and templates.
filename
- the DICOM SR instance to be validatedjavax.xml.parsers.ParserConfigurationException
javax.xml.transform.TransformerException
java.io.UnsupportedEncodingException
java.io.IOException
DicomException
public java.lang.String validate(java.lang.String filename, boolean describe, boolean matchCase, boolean checkAmbiguousTemplate, boolean checkContentItemOrder, boolean checkTemplateID) throws javax.xml.parsers.ParserConfigurationException, javax.xml.transform.TransformerException, java.io.UnsupportedEncodingException, java.io.IOException, DicomException
Validate a DICOM SR instance against the standard IOD for the appropriate SOP Class and templates.
filename
- the DICOM SR instance to be validateddescribe
- whether or not to describe the details of the validation procedure step by stepmatchCase
- whether or not to match the case of code meanings when validating them against the expected values in context groups and templatescheckAmbiguousTemplate
- whether or not to check and warn about ambiguous inclusion of templates (different templates match same content)checkContentItemOrder
- whether or not to check and warn about content item order not matching order in templates (irrespective of whether order deemed significant in template definition)checkTemplateID
- whether or not to check if encoded Template ID on CONTAINERs match expected templatejavax.xml.parsers.ParserConfigurationException
javax.xml.transform.TransformerException
java.io.UnsupportedEncodingException
java.io.IOException
DicomException
protected java.lang.String validateFirstPass(org.w3c.dom.Document inputDocument) throws javax.xml.parsers.ParserConfigurationException, javax.xml.transform.TransformerException, java.io.UnsupportedEncodingException
Perform the first pass of the validation.
Checks the document against the stylesheet and tracks which nodes matched templates.
inputDocument
- the XML representation of the DICOM SR instance to be validatedjavax.xml.parsers.ParserConfigurationException
javax.xml.transform.TransformerException
java.io.UnsupportedEncodingException
protected java.lang.String validateSecondPass(org.w3c.dom.Document inputDocument, java.lang.String firstOutputString) throws javax.xml.parsers.ParserConfigurationException, javax.xml.transform.TransformerException, java.io.UnsupportedEncodingException, java.io.IOException
Perform the second pass of the validation.
Checks for unused content items.
inputDocument
- the XML representation of the DICOM SR instance to be validatedfirstOutputString
- the text output of the first validation pass that contains a list of items found in the first passjavax.xml.parsers.ParserConfigurationException
javax.xml.transform.TransformerException
java.io.UnsupportedEncodingException
java.io.IOException