Package javax.jdo.metadata

Interface JoinMetadata

  • All Superinterfaces:
    Metadata
    public interface JoinMetadata
extends Metadata
    Represents join information.
    Since:
    3.0

    • Method Detail

      • setColumn

        JoinMetadata setColumn​(String column)
        Method to set the join column.
        Parameters:
        column - Name of the join column
        Returns:
        This metadata object

      • getColumn

        String getColumn()
        Accessor for the join column name.
        Returns:
        The column name

      • setTable

        JoinMetadata setTable​(String table)
        Method to set the table name.
        Parameters:
        table - Table name
        Returns:
        This metadata object

      • getTable

        String getTable()
        Accessor for the name of the table.
        Returns:
        The name

      • setOuter

        JoinMetadata setOuter​(boolean outer)
        Method to set whether to use an outer join.
        Parameters:
        outer - Outer join?
        Returns:
        This metadata object

      • getOuter

        boolean getOuter()
        Accessor for whether to use an outer join.
        Returns:
        Outer join?

      • setDeleteAction

        JoinMetadata setDeleteAction​(ForeignKeyAction action)
        Method to set the delete action of the FK
        Parameters:
        action - Delete action of the FK
        Returns:
        This metadata object

      • getDeleteAction

        ForeignKeyAction getDeleteAction()
        Accessor for the delete action of the FK.
        Returns:
        The FK delete-action

      • setIndexed

        JoinMetadata setIndexed​(Indexed indexed)
        Method to set whether indexed.
        Parameters:
        indexed - Whether indexed (true | false | unique)
        Returns:
        This metadata object

      • getIndexed

        Indexed getIndexed()
        Accessor for whether indexed (true|false|unique).
        Returns:
        Indexed?

      • setUnique

        JoinMetadata setUnique​(boolean unique)
        Method to set whether it is unique.
        Parameters:
        unique - Unique?
        Returns:
        This metadata object

      • getUnique

        Boolean getUnique()
        Accessor for whether unique.
        Returns:
        Unique?

      • newIndexMetadata

        IndexMetadata newIndexMetadata()
        Method to set new index metadata for the join.
        Returns:
        The IndexMetadata

      • getIndexMetadata

        IndexMetadata getIndexMetadata()
        Accessor for any index metadata on this join.
        Returns:
        Index metadata

      • newUniqueMetadata

        UniqueMetadata newUniqueMetadata()
        Method to set new unique constraint metadata for the join.
        Returns:
        The UniqueMetadata

      • getUniqueMetadata

        UniqueMetadata getUniqueMetadata()
        Accessor for any unique constraint metadata on this join.
        Returns:
        The UniqueMetadata

      • newForeignKeyMetadata

        ForeignKeyMetadata newForeignKeyMetadata()
        Method to set new foreign key metadata for the join.
        Returns:
        The ForeignKeyMetadata

      • getForeignKeyMetadata

        ForeignKeyMetadata getForeignKeyMetadata()
        Accessor for any foreign key metadata on this join.
        Returns:
        The ForeignKeyMetadata

      • newPrimaryKeyMetadata

        PrimaryKeyMetadata newPrimaryKeyMetadata()
        Method to set new primary key metadata for the join.
        Returns:
        The PrimaryKeyMetadata

      • getPrimaryKeyMetadata

        PrimaryKeyMetadata getPrimaryKeyMetadata()
        Accessor for any primary key metadata on this join.
        Returns:
        The PrimaryKeyMetadata

      • getColumns

        ColumnMetadata[] getColumns()
        Accessor for all column(s) defined on the join.
        Returns:
        The column(s)

      • newColumnMetadata

        ColumnMetadata newColumnMetadata()
        Add a new column for this join.
        Returns:
        The ColumnMetadata

      • getNumberOfColumns

        int getNumberOfColumns()
        Accessor for the number of columns defined for this join.
        Returns:
        The number of columns