Package org.ivoa.dm.regtap
Class Schema
java.lang.Object
org.ivoa.dm.regtap.Schema
- All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations,org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity
@VoDml(id="RegTAP:Schema",
role=objectType)
public class Schema
extends Object
implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
Sets of tables related to resources.
objectType: Schema
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classA builder class for Schema, mainly for use in the functional builder pattern. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Longinserted database keyprotected StringA free text description of the tableset explaining in general how all of the tables are related.protected IntegerAn arbitrary identifier for the res_schema rows belonging to a resource.protected StringA name for the set of tables.protected StringA descriptive, human-interpretable name for the table set.protected StringAn identifier for a concept in a data model that the data in this schema as a whole represent. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Schemacreate a Schema in functional builder style.voiddelete(jakarta.persistence.EntityManager em) voidgetId()Returns schema_description Attribute.Returns schema_index Attribute.Returns schema_name Attribute.Returns schema_title Attribute.Returns schema_utype Attribute.voidsetSchema_description(String pSchema_description) Set schema_description Attribute.voidsetSchema_index(Integer pSchema_index) Set schema_index Attribute.voidsetSchema_name(String pSchema_name) Set schema_name Attribute.voidsetSchema_title(String pSchema_title) Set schema_title Attribute.voidsetSchema_utype(String pSchema_utype) Set schema_utype Attribute.voidupdateUsing(Schema other) Update this object with the content of the given object.withSchema_description(String pSchema_description) fluent setter for schema_description Attribute.withSchema_index(Integer pSchema_index) fluent setter for schema_index Attribute.withSchema_name(String pSchema_name) fluent setter for schema_name Attribute.withSchema_title(String pSchema_title) fluent setter for schema_title Attribute.withSchema_utype(String pSchema_utype) fluent setter for schema_utype Attribute.
-
Field Details
-
_id
inserted database key -
schema_index
@VoDml(id="RegTAP:Schema.schema_index", role=attribute, type="ivoa:nonnegativeInteger", typeRole=primitiveType) protected Integer schema_indexAn arbitrary identifier for the res_schema rows belonging to a resource. : Attribute schema_index : multiplicity 1 -
schema_description
@VoDml(id="RegTAP:Schema.schema_description", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String schema_descriptionA free text description of the tableset explaining in general how all of the tables are related. : Attribute schema_description : multiplicity 0..1 -
schema_name
@VoDml(id="RegTAP:Schema.schema_name", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String schema_nameA name for the set of tables. : Attribute schema_name : multiplicity 1 -
schema_title
@VoDml(id="RegTAP:Schema.schema_title", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String schema_titleA descriptive, human-interpretable name for the table set. : Attribute schema_title : multiplicity 0..1 -
schema_utype
@VoDml(id="RegTAP:Schema.schema_utype", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String schema_utypeAn identifier for a concept in a data model that the data in this schema as a whole represent. : Attribute schema_utype : multiplicity 0..1
-
-
Constructor Details
-
Schema
public Schema()Creates a new Schema -
Schema
public Schema(Integer schema_index, String schema_description, String schema_name, String schema_title, String schema_utype) full parameter constructor.- Parameters:
schema_index- An arbitrary identifier for the res_schema rows belonging to a resource.schema_description- A free text description of the tableset explaining in general how all of the tables are related.schema_name- A name for the set of tables.schema_title- A descriptive, human-interpretable name for the table set.schema_utype- An identifier for a concept in a data model that the data in this schema as a whole represent.
-
Schema
Copy Constructor. Note that references will remain as is rather than be copied.- Parameters:
other- the object to be copied.
-
-
Method Details
-
getId
- Specified by:
getIdin interfaceorg.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>- Returns:
- the id
-
updateUsing
Update this object with the content of the given object. Note that references will remain as is rather than be copied.- Parameters:
other- the object to be copied.
-
getSchema_index
Returns schema_index Attribute.- Returns:
- schema_index Attribute
-
setSchema_index
Set schema_index Attribute.- Parameters:
pSchema_index- value to set
-
withSchema_index
fluent setter for schema_index Attribute.- Parameters:
pSchema_index- value to set- Returns:
- Schema
-
getSchema_description
Returns schema_description Attribute.- Returns:
- schema_description Attribute
-
setSchema_description
Set schema_description Attribute.- Parameters:
pSchema_description- value to set
-
withSchema_description
fluent setter for schema_description Attribute.- Parameters:
pSchema_description- value to set- Returns:
- Schema
-
getSchema_name
Returns schema_name Attribute.- Returns:
- schema_name Attribute
-
setSchema_name
Set schema_name Attribute.- Parameters:
pSchema_name- value to set
-
withSchema_name
fluent setter for schema_name Attribute.- Parameters:
pSchema_name- value to set- Returns:
- Schema
-
getSchema_title
Returns schema_title Attribute.- Returns:
- schema_title Attribute
-
setSchema_title
Set schema_title Attribute.- Parameters:
pSchema_title- value to set
-
withSchema_title
fluent setter for schema_title Attribute.- Parameters:
pSchema_title- value to set- Returns:
- Schema
-
getSchema_utype
Returns schema_utype Attribute.- Returns:
- schema_utype Attribute
-
setSchema_utype
Set schema_utype Attribute.- Parameters:
pSchema_utype- value to set
-
withSchema_utype
fluent setter for schema_utype Attribute.- Parameters:
pSchema_utype- value to set- Returns:
- Schema
-
createSchema
create a Schema in functional builder style.- Parameters:
f- the functional builder.- Returns:
- an object initialized from the builder.
-
forceLoad
public void forceLoad()- Specified by:
forceLoadin interfaceorg.ivoa.vodml.jpa.JPAManipulations
-
delete
public void delete(jakarta.persistence.EntityManager em) - Specified by:
deletein interfaceorg.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
-