Package org.ivoa.dm.proposal.prop
Class ProposalModel
java.lang.Object
org.ivoa.dm.proposal.prop.ProposalModel
- All Implemented Interfaces:
org.ivoa.vodml.jaxb.JaxbManagement,org.ivoa.vodml.VodmlModel<ProposalModel>
@VoDml(id="proposal",
role=model,
type="proposal")
public class ProposalModel
extends Object
implements org.ivoa.vodml.VodmlModel<ProposalModel>
The container class for the proposal Model. A model to represent an application for observing
time. The model is intended to express all of the concepts required to specify the scientific
parameters of the application in sufficient detail to allow the proposal to be reviewed and
allocated time. It does not cover all the technical detail of instrument setup that would be
needed to actually schedule the observations, although the intention is that information about
targets etc. could be automatically transferred to an observing system.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classA container class for the references in the model. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final org.ivoa.vodml.ModelDescriptionthe description. -
Constructor Summary
ConstructorsConstructorDescriptiondefault constructor.ProposalModel(ProposalModel.References refs_, List<AbstractProposal> abstractProposal_) constructor for deserialization from JSON. -
Method Summary
Modifier and TypeMethodDescriptionvoidadd AbstractProposal to model.voiddirectly add reference.voiddirectly add reference.voiddirectly add reference.static jakarta.xml.bind.JAXBContextthe context factory for the model.voidcreate a context in preparation for cloning.voidremove AbstractProposal from model.<T> List<T>getContent(Class<T> c) Get the content of the given type.static booleanif the model has references.static booleanisInVocabulary(String value, String vocabulary) Test if a term is in the vocabulary.static com.fasterxml.jackson.databind.ObjectMapperReturn a Jackson objectMapper suitable for JSON serialzation.org.ivoa.vodml.ModelManagement<ProposalModel>generate management interface instance for model.voidstatic Stringpu_name()The persistence unit name for the model.static InputStreamthe TAP schema for the model.
-
Field Details
-
modelDescription
public static final org.ivoa.vodml.ModelDescription modelDescriptionthe description.
-
-
Constructor Details
-
ProposalModel
public ProposalModel()default constructor. -
ProposalModel
constructor for deserialization from JSON. Though it can be used manually too.- Parameters:
refs_- the referencesabstractProposal_- the content of type org.ivoa.dm.proposal.prop.AbstractProposal
-
-
Method Details
-
isInVocabulary
Test if a term is in the vocabulary.- Parameters:
value- the value to testvocabulary- the uri for the vocabulary.- Returns:
- true if the term is in the vocabulary.
-
addContent
add AbstractProposal to model.- Parameters:
c_- org.ivoa.dm.proposal.prop.AbstractProposal
-
deleteContent
remove AbstractProposal from model.- Parameters:
c_- org.ivoa.dm.proposal.prop.AbstractProposal
-
getAbstractProposal
-
addReference
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
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
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
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:
processReferencesin interfaceorg.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.JAXBExceptionthe context factory for the model.- Returns:
- the JAXBContext.
- Throws:
jakarta.xml.bind.JAXBException- if there is a problem.
-
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
generate management interface instance for model.- Specified by:
managementin interfaceorg.ivoa.vodml.VodmlModel<ProposalModel>- Returns:
- the management interface.
-
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.
-