Class ForeignKeyConstraint

  • All Implemented Interfaces:

    public class ForeignKeyConstraint
    extends java.lang.Object

    Purpose: Define a foreign key from one table to another. This support composite foreign keys can constraint options.

    See Also:
    Serialized Form
    • Field Detail

      • name

        protected java.lang.String name
      • sourceFields

        protected java.util.List<java.lang.String> sourceFields
      • targetFields

        protected java.util.List<java.lang.String> targetFields
      • targetTable

        protected java.lang.String targetTable
      • shouldCascadeOnDelete

        protected boolean shouldCascadeOnDelete
      • foreignKeyDefinition

        protected java.lang.String foreignKeyDefinition
      • disableForeignKey

        protected boolean disableForeignKey
    • Constructor Detail

      • ForeignKeyConstraint

        public ForeignKeyConstraint()
      • ForeignKeyConstraint

        public ForeignKeyConstraint​(java.lang.String name,
                                    java.lang.String sourceField,
                                    java.lang.String targetField,
                                    java.lang.String targetTable)
    • Method Detail

      • addSourceField

        public void addSourceField​(java.lang.String sourceField)
      • addTargetField

        public void addTargetField​(java.lang.String targetField)
      • appendDBString

        public void appendDBString​( writer,
                                   org.eclipse.persistence.internal.sessions.AbstractSession session)
        INTERNAL: Append the database field definition string to the table creation statement.
      • cascadeOnDelete

        public void cascadeOnDelete()
        PUBLIC: Enables delete cascading on the database. This must be used carefully, i.e. only private relationships.
      • disableForeignKey

        public boolean disableForeignKey()
      • dontCascadeOnDelete

        public void dontCascadeOnDelete()
        PUBLIC: Disables delete cascading on the database, this is the default.
      • getForeignKeyDefinition

        public java.lang.String getForeignKeyDefinition()
      • getName

        public java.lang.String getName()
      • getSourceFields

        public java.util.List<java.lang.String> getSourceFields()
      • getTargetFields

        public java.util.List<java.lang.String> getTargetFields()
      • getTargetTable

        public java.lang.String getTargetTable()
      • hasForeignKeyDefinition

        public boolean hasForeignKeyDefinition()
      • isDisableForeignKey

        public boolean isDisableForeignKey()
      • setDisableForeignKey

        public void setDisableForeignKey​(boolean disableForeignKey)
      • setForeignKeyDefinition

        public void setForeignKeyDefinition​(java.lang.String foreignKeyDefinition)
      • setName

        public void setName​(java.lang.String name)
      • setShouldCascadeOnDelete

        public void setShouldCascadeOnDelete​(boolean shouldCascadeOnDelete)
        PUBLIC: Enables delete cascading on the database. This must be used carefully, i.e. only private relationships.
      • setSourceFields

        public void setSourceFields​(java.util.List<java.lang.String> sourceFields)
      • setTargetFields

        public void setTargetFields​(java.util.List<java.lang.String> targetFields)
      • setTargetTable

        public void setTargetTable​(java.lang.String targetTable)
      • shouldCascadeOnDelete

        public boolean shouldCascadeOnDelete()