edu.mayo.informatics.lexgrid.convert.utility.loaderPreferences.interfaces
Interface PreferenceLoader

All Known Implementing Classes:
HL7PreferenceLoader, MetaPreferenceLoader, OBOPreferenceLoader, OWLPreferenceLoader, SemNetPreferenceLoader, UMLSPreferenceLoader, XMLPreferenceLoader

public interface PreferenceLoader


Method Summary
 java.net.URI getPreferencesURI()
          Gets the URI of the loaded Preferences XML file.
 LoaderPreferences load()
          Returns a generic Preferences object.
 void setPreferencesURI(java.net.URI input)
          Sets the Loader to use the specified XML Preferences XML file.
 boolean validate()
          Validates the loaded Preference XML file against the appropriate XSD
 

Method Detail

validate

boolean validate()
Validates the loaded Preference XML file against the appropriate XSD

Returns:
Whether or not the XML validates against the given XSD. Any errors will be logged.

load

LoaderPreferences load()
                       throws LgConvertException
Returns a generic Preferences object. This method will NOT validate against an XSD, but will do minimum checks to determine if the XML is well-formed.

Returns:
The generic Preferences Object. Because each loader implements its preferences independently, this method returns a generic Object. Use a specific loader to get each format's specific preferences object.
Throws:
LgConvertException

getPreferencesURI

java.net.URI getPreferencesURI()
Gets the URI of the loaded Preferences XML file.

Returns:
The URI of the XML Preferences file assigned to the loader

setPreferencesURI

void setPreferencesURI(java.net.URI input)
Sets the Loader to use the specified XML Preferences XML file.

Parameters:
input - The URI of the XML Preferences file to be assigned to the loader

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.