Package uk.ac.starlink.vo
Class ForeignMeta
java.lang.Object
uk.ac.starlink.vo.ForeignMeta
Represents foreign key information from a TableSet document.
- Since:
- 21 Jan 2011
- Author:
- Mark Taylor
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Represents a linkage from a column in the source table to a column in the target table. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the description for this foreign key.getKeyId()
Returns the key ID associated with this foreign key.getLinks()
Returns the column links associated with this foreign key.Returns the fully-qualified name of the target table for this foreign key.getUtype()
Returns the utype associated with this foreign key.void
setLinks
(ForeignMeta.Link[] links) Sets the links contained in this table.toString()
-
Constructor Details
-
ForeignMeta
protected ForeignMeta()Constructor.
-
-
Method Details
-
getTargetTable
Returns the fully-qualified name of the target table for this foreign key.- Returns:
- target table name
-
getDescription
Returns the description for this foreign key.- Returns:
- text description
-
getUtype
Returns the utype associated with this foreign key.- Returns:
- utype
-
getKeyId
Returns the key ID associated with this foreign key.- Returns:
- key ID
-
getLinks
Returns the column links associated with this foreign key. If the result is null, nothing is known about the links, and the list may need to be explicitly set.- Returns:
- array of links associated with this foreign key, or null
-
setLinks
Sets the links contained in this table.- Parameters:
links
- link array
-
toString
-