Package uk.ac.starlink.vo
Class SchemaMeta
java.lang.Object
uk.ac.starlink.vo.SchemaMeta
Represents schema metadata from a TableSet document.
The scalar members are intended to be set by classes in this package
near construction time.
The tables member may or may not be populated, depending on the
source of the instance;
check the documentation for the relevant factory class.
- Since:
- 6 Feb 2015
- Author:
- Mark Taylor
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic SchemaMeta
createDummySchema
(String name) Returns a new schema with no tables and the given name.Returns this schema's description.Returns a map of additional non-standard metadata items for this schema.getIndex()
Returns this schema's schema index.getName()
Returns this schema's name.Returns a list of the tables contained in this schema.getTitle()
Returns this schema's human-readable title.getUtype()
Returns this schema's utype.void
setTableOrder
(Comparator<TableMeta> tableComparator) Configures a comparator that will define the ordering of tables returned by this schema'sgetTables()
method.void
Sets the tables contained in this schema.toString()
Returns this schema's name.
-
Constructor Details
-
SchemaMeta
protected SchemaMeta()Constructor.
-
-
Method Details
-
getName
Returns this schema's name.- Returns:
- name
-
getTitle
Returns this schema's human-readable title. Note, this is supplied by VODataService, but not by TAP_SCHEMA.- Returns:
- human-readable title
-
getDescription
Returns this schema's description.- Returns:
- text description
-
getIndex
Returns this schema's schema index.- Returns:
- schema index, or null if not available
-
getUtype
Returns this schema's utype.- Returns:
- utype string
-
getExtras
Returns a map of additional non-standard metadata items for this schema.- Returns:
- extras map
-
getTables
Returns a list of the tables contained in this schema. If the result is null, nothing is known about the tables, and the list may need to be explicitly set.If
setTableOrder(java.util.Comparator<uk.ac.starlink.vo.TableMeta>)
has been called with a non-null comparator, the returned array will obey that ordering.- Returns:
- tables contained in this schema, or null
-
setTables
Sets the tables contained in this schema.- Parameters:
tables
- table list
-
setTableOrder
Configures a comparator that will define the ordering of tables returned by this schema'sgetTables()
method.- Parameters:
tableComparator
- defines table list ordering
-
toString
Returns this schema's name. -
createDummySchema
Returns a new schema with no tables and the given name.- Parameters:
name
- name of new schema- Returns:
- new empty schema
-