Package org.javastro.ivoa.entities.vodml

Class ModelImport

java.lang.Object

org.javastro.ivoa.entities.vodml.ModelImport

All Implemented Interfaces:

org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public class ModelImport
extends Object
implements org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

A "proxy" for an external model that is being used by the current model. Defines the url where the VO-DML representation of that model can be retrieved, and replicates its name that MUST be used when making references to elements in that model using a VODMLREF element.

Java class for ModelImport complex type

.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ModelImport">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="name" type="{http://www.ivoa.net/xml/VODML/v1}ModelName"/>
         <element name="identifier" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="version" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="url" type="{http://www.w3.org/2001/XMLSchema}anyURI"/>
         <element name="documentationURL" type="{http://www.w3.org/2001/XMLSchema}anyURI"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected String	documentationURL	URL where a documentation HTML file for the remote model can be downloaded.
protected String	identifier	A string holding the identifier by which the imported model is registered in an IVOA compatible registry.
protected String	name	Name by which imported model is used in the current model and its documentation.
protected String	url	URL from which the VO-DML model document can be downloaded.
protected String	version	Version of the imported model.

Constructor Summary

Constructors

Constructor	Description
ModelImport()	Default no-arg constructor
ModelImport(String name, String identifier, String version, String url, String documentationURL)	Fully-initialising value constructor

Method Summary

Modifier and Type	Method	Description
StringBuilder	append(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
StringBuilder	appendFields(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
Object	createNewInstance()
boolean	equals(Object object)
String	getDocumentationURL()	URL where a documentation HTML file for the remote model can be downloaded.
String	getIdentifier()	A string holding the identifier by which the imported model is registered in an IVOA compatible registry.
String	getName()	Name by which imported model is used in the current model and its documentation.
String	getUrl()	URL from which the VO-DML model document can be downloaded.
String	getVersion()	Version of the imported model.
int	hashCode()
void	mergeFrom(Object left, Object right)
void	mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator, org.jvnet.jaxb.locator.ObjectLocator rightLocator, Object left, Object right, org.jvnet.jaxb.lang.MergeStrategy strategy)
void	setDocumentationURL(String value)	Sets the value of the documentationURL property.
void	setIdentifier(String value)	Sets the value of the identifier property.
void	setName(String value)	Sets the value of the name property.
void	setUrl(String value)	Sets the value of the url property.
void	setVersion(String value)	Sets the value of the version property.
String	toString()
ModelImport	withDocumentationURL(String value)
ModelImport	withIdentifier(String value)
ModelImport	withName(String value)
ModelImport	withUrl(String value)
ModelImport	withVersion(String value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

name

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
protected String name

Name by which imported model is used in the current model and its documentation. This name MUST be the same as the 'name' of the model definition in that remote document. For all utypes pointing to elements in the imported model MUST use this name as prefix.

identifier

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
protected String identifier

A string holding the identifier by which the imported model is registered in an IVOA compatible registry. Must be the same value as the 'identifier' of the imported model.

version

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
protected String version

Version of the imported model.

url

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
protected String url

URL from which the VO-DML model document can be downloaded. Note, could likely be done through a registry once ivoId is known. TBD SHOULD this be a generic URI, or can we insits on URL?

documentationURL

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
protected String documentationURL

URL where a documentation HTML file for the remote model can be downloaded. This SHOULD be a document that contains anchors for each element thta has as name attribute the vodml-id of that element. I.e. it is assumed that the vodml-id-s of the imported types can be added onto this documentationURL (should end with a #?) so that a direct link to the documentation for a referenced data model element can be found.

Constructor Details

ModelImport

public ModelImport()

Default no-arg constructor

ModelImport

public ModelImport(String name,
 String identifier,
 String version,
 String url,
 String documentationURL)

Fully-initialising value constructor

Method Details

getName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public String getName()

Name by which imported model is used in the current model and its documentation. This name MUST be the same as the 'name' of the model definition in that remote document. For all utypes pointing to elements in the imported model MUST use this name as prefix.

Returns:

possible object is String

setName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void setName(String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

See Also:

• getName()

getIdentifier

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public String getIdentifier()

A string holding the identifier by which the imported model is registered in an IVOA compatible registry. Must be the same value as the 'identifier' of the imported model.

Returns:

possible object is String

setIdentifier

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void setIdentifier(String value)

Sets the value of the identifier property.

Parameters:

value - allowed object is String

See Also:

• getIdentifier()

getVersion

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public String getVersion()

Version of the imported model.

Returns:

possible object is String

setVersion

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void setVersion(String value)

Sets the value of the version property.

Parameters:

value - allowed object is String

See Also:

• getVersion()

getUrl

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public String getUrl()

URL from which the VO-DML model document can be downloaded. Note, could likely be done through a registry once ivoId is known. TBD SHOULD this be a generic URI, or can we insits on URL?

Returns:

possible object is String

setUrl

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void setUrl(String value)

Sets the value of the url property.

Parameters:

value - allowed object is String

See Also:

• getUrl()

getDocumentationURL

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public String getDocumentationURL()

URL where a documentation HTML file for the remote model can be downloaded. This SHOULD be a document that contains anchors for each element thta has as name attribute the vodml-id of that element. I.e. it is assumed that the vodml-id-s of the imported types can be added onto this documentationURL (should end with a #?) so that a direct link to the documentation for a referenced data model element can be found.

Returns:

possible object is String

setDocumentationURL

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void setDocumentationURL(String value)

Sets the value of the documentationURL property.

Parameters:

value - allowed object is String

See Also:

• getDocumentationURL()

equals

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public int hashCode()

Overrides:

hashCode in class Object

toString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public String toString()

Overrides:

toString in class Object

append

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public StringBuilder append(org.jvnet.jaxb.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb.lang.ToStringStrategy strategy)

Specified by:

append in interface org.jvnet.jaxb.lang.ToString

appendFields

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public StringBuilder appendFields(org.jvnet.jaxb.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb.lang.ToStringStrategy strategy)

Specified by:

appendFields in interface org.jvnet.jaxb.lang.ToString

withName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ModelImport withName(String value)

withIdentifier

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ModelImport withIdentifier(String value)

withVersion

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ModelImport withVersion(String value)

withUrl

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ModelImport withUrl(String value)

withDocumentationURL

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public ModelImport withDocumentationURL(String value)

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void mergeFrom(Object left,
 Object right)

Specified by:

mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator,
 org.jvnet.jaxb.locator.ObjectLocator rightLocator,
 Object left,
 Object right,
 org.jvnet.jaxb.lang.MergeStrategy strategy)

Specified by:

mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

createNewInstance

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Object createNewInstance()

Specified by:

createNewInstance in interface org.jvnet.jaxb.lang.MergeFrom