Package org.ivoa.dm.registry.vodataservice

Class ForeignKey.ForeignKeyBuilder

java.lang.Object
org.ivoa.dm.registry.vodataservice.ForeignKey.ForeignKeyBuilder
Enclosing class:
ForeignKey
public static class ForeignKey.ForeignKeyBuilder extends Object
A builder class for ForeignKey, mainly for use in the functional builder pattern.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    String
    description
    A free-text description of what this key points to and what the relationship means.
    List<FKColumn>
    fkColumn
    A pair of column names, one from this table and one from the target table that should be used to join the tables in a query.
    String
    targetTable
    The fully qualified name (including catalogue and schema, as applicable) of the table that can be joined with the table containing this foreign key.
    String
    utype
    An identifier for a concept in a data model that the association enabled by this key represents.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ForeignKeyBuilder()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    ForeignKey
    create()
    create a ForeignKey from this builder.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • targetTable

      public String targetTable
      The fully qualified name (including catalogue and schema, as applicable) of the table that can be joined with the table containing this foreign key.

    • fkColumn

      public List<FKColumn> fkColumn
      A pair of column names, one from this table and one from the target table that should be used to join the tables in a query.

    • description

      public String description
      A free-text description of what this key points to and what the relationship means.

    • utype

      public String utype
      An identifier for a concept in a data model that the association enabled by this key represents. The form of the utype string depends on the data model; common forms are sequences of dotted identifiers (e.g., in SSA) or URIs (e.g., in RegTAP).

  • Constructor Details

    • ForeignKeyBuilder

      public ForeignKeyBuilder()

  • Method Details

    • create

      public ForeignKey create()
      create a ForeignKey from this builder.
      Returns:
      an object initialized from the builder.