Module: Chemicalml::Convention

Defined in:
lib/chemicalml/convention.rb,
lib/chemicalml/convention/base.rb,
lib/chemicalml/convention/compchem.rb,
lib/chemicalml/convention/registry.rb,
lib/chemicalml/convention/molecular.rb,
lib/chemicalml/convention/violation.rb,
lib/chemicalml/convention/constraint.rb,
lib/chemicalml/convention/dictionary.rb,
lib/chemicalml/convention/unit_dictionary.rb,
lib/chemicalml/convention/compchem/constraints.rb,
lib/chemicalml/convention/unit_type_dictionary.rb,
lib/chemicalml/convention/molecular/constraints.rb,
lib/chemicalml/convention/dictionary/constraints.rb,
lib/chemicalml/convention/unit_dictionary/constraints.rb,
lib/chemicalml/convention/unit_type_dictionary/constraints.rb,
lib/chemicalml/convention/dictionary/constraints/entry_must_have_id_and_term.rb,
lib/chemicalml/convention/molecular/constraints/atom_array_must_contain_atoms.rb,
lib/chemicalml/convention/compchem/constraints/job_must_contain_initialization.rb,
lib/chemicalml/convention/molecular/constraints/atom_ids_unique_within_molecule.rb,
lib/chemicalml/convention/dictionary/constraints/entry_ids_unique_within_dictionary.rb,
lib/chemicalml/convention/compchem/constraints/compchem_module_must_contain_job_list.rb,
lib/chemicalml/convention/unit_dictionary/constraints/unit_must_have_symbol_and_unit_type.rb,
lib/chemicalml/convention/molecular/constraints/bond_must_reference_atoms_in_same_molecule.rb,
lib/chemicalml/convention/unit_type_dictionary/constraints/unit_type_must_have_id_and_name.rb

Overview

Convention framework. A convention is a named, namespaced set of constraints that CML documents conform to in a particular domain.

Conventions are registered, not switch-statement'd. Each convention owns its constraint classes; the framework walks whatever was registered.

The five built-in conventions:

molecular            http://www.xml-cml.org/convention/molecular
compchem             http://www.xml-cml.org/convention/compchem
dictionary           http://www.xml-cml.org/convention/dictionary
unit-dictionary      http://www.xml-cml.org/convention/unit-dictionary
unitType-dictionary  http://www.xml-cml.org/convention/unitType-dictionary

Defined Under Namespace

Modules: Base, Compchem, Dictionary, Molecular, Registry, UnitDictionary, UnitTypeDictionary Classes: Constraint, Violation

Constant Summary collapse

CONVENTION_NAMESPACE = 
"http://www.xml-cml.org/convention/".freeze

Class Method Summary collapse

Class Method Details

.lookup(qname) ⇒ Object 



31
32
33
 
# File 'lib/chemicalml/convention.rb', line 31

def self.lookup(qname)
  Registry.lookup(qname)
end

.validate(document, qname:) ⇒ Object 



35
36
37
 
# File 'lib/chemicalml/convention.rb', line 35

def self.validate(document, qname:)
  Registry.validate(document, qname: qname)
end