Package org.ivoa.dm.regtap
Class TAPTable
java.lang.Object
org.ivoa.dm.regtap.TAPTable
- All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations,org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity
@VoDml(id="RegTAP:TAPTable",
role=objectType)
public class TAPTable
extends Object
implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
TAP-queriable tables.
objectType: TAPTable
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classA builder class for TAPTable, mainly for use in the functional builder pattern. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Longinserted database keyprotected StringIVOA identifier of the TAP service making this table queriable.protected StringA free-text description of the table's contents.protected StringThe fully qualified name of the table.protected StringA descriptive, human-interpretable name for the table.protected StringAn identifier for a concept in a data model that the data in this table as a whole represent. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic TAPTablecreate a TAPTable in functional builder style.voiddelete(jakarta.persistence.EntityManager em) voidgetId()getSvcid()Returns svcid Attribute.Returns table_description Attribute.Returns table_name Attribute.Returns table_title Attribute.Returns table_utype Attribute.voidSet svcid Attribute.voidsetTable_description(String pTable_description) Set table_description Attribute.voidsetTable_name(String pTable_name) Set table_name Attribute.voidsetTable_title(String pTable_title) Set table_title Attribute.voidsetTable_utype(String pTable_utype) Set table_utype Attribute.voidupdateUsing(TAPTable other) Update this object with the content of the given object.fluent setter for svcid Attribute.withTable_description(String pTable_description) fluent setter for table_description Attribute.withTable_name(String pTable_name) fluent setter for table_name Attribute.withTable_title(String pTable_title) fluent setter for table_title Attribute.withTable_utype(String pTable_utype) fluent setter for table_utype Attribute.
-
Field Details
-
_id
inserted database key -
svcid
@VoDml(id="RegTAP:TAPTable.svcid", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String svcidIVOA identifier of the TAP service making this table queriable. : Attribute svcid : multiplicity 1 -
table_name
@VoDml(id="RegTAP:TAPTable.table_name", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String table_nameThe fully qualified name of the table. As per VODataService, this includes all catalog or schema prefixes needed to distinguish it in a query, and it comes with SQL delimiters where necessary. : Attribute table_name : multiplicity 1 -
table_title
@VoDml(id="RegTAP:TAPTable.table_title", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String table_titleA descriptive, human-interpretable name for the table. : Attribute table_title : multiplicity 1 -
table_description
@VoDml(id="RegTAP:TAPTable.table_description", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String table_descriptionA free-text description of the table's contents. : Attribute table_description : multiplicity 1 -
table_utype
@VoDml(id="RegTAP:TAPTable.table_utype", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String table_utypeAn identifier for a concept in a data model that the data in this table as a whole represent. : Attribute table_utype : multiplicity 1
-
-
Constructor Details
-
TAPTable
public TAPTable()Creates a new TAPTable -
TAPTable
public TAPTable(String svcid, String table_name, String table_title, String table_description, String table_utype) full parameter constructor.- Parameters:
svcid- IVOA identifier of the TAP service making this table queriable.table_name- The fully qualified name of the table. As per VODataService, this includes all catalog or schema prefixes needed to distinguish it in a query, and it comes with SQL delimiters where necessary.table_title- A descriptive, human-interpretable name for the table.table_description- A free-text description of the table's contents.table_utype- An identifier for a concept in a data model that the data in this table as a whole represent.
-
TAPTable
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.
-
getSvcid
Returns svcid Attribute.- Returns:
- svcid Attribute
-
setSvcid
Set svcid Attribute.- Parameters:
pSvcid- value to set
-
withSvcid
fluent setter for svcid Attribute.- Parameters:
pSvcid- value to set- Returns:
- TAPTable
-
getTable_name
Returns table_name Attribute.- Returns:
- table_name Attribute
-
setTable_name
Set table_name Attribute.- Parameters:
pTable_name- value to set
-
withTable_name
fluent setter for table_name Attribute.- Parameters:
pTable_name- value to set- Returns:
- TAPTable
-
getTable_title
Returns table_title Attribute.- Returns:
- table_title Attribute
-
setTable_title
Set table_title Attribute.- Parameters:
pTable_title- value to set
-
withTable_title
fluent setter for table_title Attribute.- Parameters:
pTable_title- value to set- Returns:
- TAPTable
-
getTable_description
Returns table_description Attribute.- Returns:
- table_description Attribute
-
setTable_description
Set table_description Attribute.- Parameters:
pTable_description- value to set
-
withTable_description
fluent setter for table_description Attribute.- Parameters:
pTable_description- value to set- Returns:
- TAPTable
-
getTable_utype
Returns table_utype Attribute.- Returns:
- table_utype Attribute
-
setTable_utype
Set table_utype Attribute.- Parameters:
pTable_utype- value to set
-
withTable_utype
fluent setter for table_utype Attribute.- Parameters:
pTable_utype- value to set- Returns:
- TAPTable
-
createTAPTable
create a TAPTable 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>
-