Package uk.ac.starlink.vo
Class ForeignMeta
- java.lang.Object
-
- uk.ac.starlink.vo.ForeignMeta
-
public class ForeignMeta extends java.lang.Object
Represents foreign key information from a TableSet document.- Since:
- 21 Jan 2011
- Author:
- Mark Taylor
- See Also:
- IVOA VODataService Recommendation
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ForeignMeta.Link
Represents a linkage from a column in the source table to a column in the target table.
-
Constructor Summary
Constructors Modifier Constructor Description protected
ForeignMeta()
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDescription()
Returns the description for this foreign key.java.lang.String
getKeyId()
Returns the key ID associated with this foreign key.ForeignMeta.Link[]
getLinks()
Returns the column links associated with this foreign key.java.lang.String
getTargetTable()
Returns the fully-qualified name of the target table for this foreign key.java.lang.String
getUtype()
Returns the utype associated with this foreign key.void
setLinks(ForeignMeta.Link[] links)
Sets the links contained in this table.java.lang.String
toString()
-
-
-
Method Detail
-
getTargetTable
public java.lang.String getTargetTable()
Returns the fully-qualified name of the target table for this foreign key.- Returns:
- target table name
-
getDescription
public java.lang.String getDescription()
Returns the description for this foreign key.- Returns:
- text description
-
getUtype
public java.lang.String getUtype()
Returns the utype associated with this foreign key.- Returns:
- utype
-
getKeyId
public java.lang.String getKeyId()
Returns the key ID associated with this foreign key.- Returns:
- key ID
-
getLinks
public ForeignMeta.Link[] 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
public void setLinks(ForeignMeta.Link[] links)
Sets the links contained in this table.- Parameters:
links
- link array
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-