Package org.ivoa.dm.tool

Class ToolModel

java.lang.Object
org.ivoa.dm.tool.ToolModel
All Implemented Interfaces:
org.ivoa.vodml.jaxb.JaxbManagement, org.ivoa.vodml.VodmlModel<ToolModel>
@VoDml(id="tool", role=model, type="tool") public class ToolModel extends Object implements org.ivoa.vodml.VodmlModel<ToolModel>
The container class for the tool Model. Tool Data Model for defining executable tools

  • Field Details

    • modelDescription

      public static final org.ivoa.vodml.ModelDescription modelDescription
      the description.

  • Constructor Details

    • ToolModel

      public ToolModel()
      default constructor.

  • Method Details

    • isInVocabulary

      public static boolean isInVocabulary(String value, String vocabulary)
      Test if a term is in the vocabulary.
      Parameters:
      value - the value to test
      vocabulary - the uri for the vocabulary.
      Returns:
      true if the term is in the vocabulary.

    • addContent

      public void addContent(Tool c)
      add Tool to model.
      Parameters:
      c - org.ivoa.dm.tool.Tool

    • deleteContent

      public void deleteContent(Tool c)
      remove Tool from model.
      Parameters:
      c - org.ivoa.dm.tool.Tool

    • addReference

      public void addReference(Author c)
      directly add reference. N.B. should not be necessary in normal operation - adding content should find embedded references.
      Parameters:
      c - the reference to be added.

    • addReference

      public void addReference(OCIRegistry c)
      directly add reference. N.B. should not be necessary in normal operation - adding content should find embedded references.
      Parameters:
      c - the reference to be added.

    • addReference

      public void addReference(ToolImage c)
      directly add reference. N.B. should not be necessary in normal operation - adding content should find embedded references.
      Parameters:
      c - the reference to be added.

    • getContent

      public <T> List<T> getContent(Class<T> c)
      Get the content of the given type.
      Type Parameters:
      T - The type of the content
      Parameters:
      c - the class of the content.
      Returns:
      the content.

    • processReferences

      public void processReferences()
      Specified by:
      processReferences in interface org.ivoa.vodml.jaxb.JaxbManagement

    • hasReferences

      public static boolean hasReferences()
      if the model has references.
      Returns:
      true if the model has references.

    • contextFactory

      public static jakarta.xml.bind.JAXBContext contextFactory() throws jakarta.xml.bind.JAXBException
      the context factory for the model.
      Returns:
      the JAXBContext.
      Throws:
      jakarta.xml.bind.JAXBException - if there is a problem.

    • pu_name

      public static String pu_name()
      The persistence unit name for the model.
      Returns:
      the name.

    • jsonMapper

      public static com.fasterxml.jackson.databind.ObjectMapper jsonMapper()
      Return a Jackson objectMapper suitable for JSON serialzation.
      Returns:
      the objectmapper.

    • management

      public org.ivoa.vodml.ModelManagement<ToolModel> management()
      generate management interface instance for model.
      Specified by:
      management in interface org.ivoa.vodml.VodmlModel<ToolModel>
      Returns:
      the management interface.

    • TAPSchema

      public static InputStream TAPSchema()
      the TAP schema for the model. The schema is represented via the TAPSchemaDM datamodel.
      Returns:
      an InputStream to the XML representation of the model.

    • createContext

      public void createContext()
      create a context in preparation for cloning.