Package org.apache.openjpa.jdbc.meta

Class NoneMappingDefaults

  • All Implemented Interfaces:
    MappingDefaults
    public class NoneMappingDefaults
extends java.lang.Object
implements MappingDefaults
    No-op mapping defaults.
    Author:
    Abe White

    • Constructor Detail

      • NoneMappingDefaults

        public NoneMappingDefaults()

    • Method Detail

      • defaultMissingInfo

        public boolean defaultMissingInfo()
        Description copied from interface: MappingDefaults
        Whether to fill in missing mapping information at runtime with the default values supplied by this plugin. A value of false means that all mapping information must be present at runtime.
        Specified by:
        defaultMissingInfo in interface MappingDefaults

      • useClassCriteria

        public boolean useClassCriteria()
        Description copied from interface: MappingDefaults
        The default for whether relations use the related object's expected class as part of the join criteria.
        Specified by:
        useClassCriteria in interface MappingDefaults

      • getStrategy

        public java.lang.Object getStrategy​(ClassMapping cls,
                                    boolean adapt)
        Description copied from interface: MappingDefaults
        Default mapping strategy when there is no explicit strategy and no hierarchy strategy given.
        Specified by:
        getStrategy in interface MappingDefaults
        Parameters:
        cls - the class; will not be mapped, but superclass and raw MappingInfo will be available
        adapt - whether we can adapt the mapping or schema
        Returns:
        the strategy alias or a strategy instance, or null

      • getStrategy

        public java.lang.Object getStrategy​(Version vers,
                                    boolean adapt)
        Description copied from interface: MappingDefaults
        Default version mapping strategy when there is no explicit strategy.
        Specified by:
        getStrategy in interface MappingDefaults
        Parameters:
        vers - the version; will not be mapped, but raw MappingInfo will be available
        adapt - whether we can adapt the mapping or schema
        Returns:
        the strategy alias or a strategy instance, or null

      • getStrategy

        public java.lang.Object getStrategy​(Discriminator disc,
                                    boolean adapt)
        Description copied from interface: MappingDefaults
        Default discriminator mapping strategy when there is no explicit strategy.
        Specified by:
        getStrategy in interface MappingDefaults
        Parameters:
        disc - the discriminator; will not be mapped, but raw MappingInfo will be available
        adapt - whether we can adapt the mapping or schema
        Returns:
        the strategy alias or a strategy instance, or null

      • getStrategy

        public java.lang.Object getStrategy​(ValueMapping vm,
                                    java.lang.Class<?> type,
                                    boolean adapt)
        Description copied from interface: MappingDefaults
        Custom handler or strategy for the given field, or null if none has been registered.
        Specified by:
        getStrategy in interface MappingDefaults
        Parameters:
        vm - the value mapping; will not be mapped, but raw MappingInfo will be available
        type - the value type
        adapt - whether we can adapt the mapping or schema
        Returns:
        the handler/strategy alias or instance, or null

      • getTableName

        public java.lang.String getTableName​(ClassMapping cls,
                                     Schema schema)
        Description copied from interface: MappingDefaults
        Return the default table name for the given class. This method is only called for classes mapped to their own table.
        Specified by:
        getTableName in interface MappingDefaults

      • getTableName

        public java.lang.String getTableName​(FieldMapping fm,
                                     Schema schema)
        Description copied from interface: MappingDefaults
        Return the default secondary table name for the given field. This method is only called for fields whose strategy requires a secondary table.
        Specified by:
        getTableName in interface MappingDefaults

      • populateDataStoreIdColumns

        public void populateDataStoreIdColumns​(ClassMapping cls,
                                       Table table,
                                       Column[] cols)
        Description copied from interface: MappingDefaults
        Fill in default information for the given datastore identity columns. The columns' name and Java type will already be populated with generic defaults that may be replaced.
        Specified by:
        populateDataStoreIdColumns in interface MappingDefaults

      • populateColumns

        public void populateColumns​(Version vers,
                            Table table,
                            Column[] cols)
        Description copied from interface: MappingDefaults
        Fill in default information for the given version columns. The columns' name and Java type will already be populated with generic defaults that may be replaced.
        Specified by:
        populateColumns in interface MappingDefaults

      • populateColumns

        public void populateColumns​(Discriminator disc,
                            Table table,
                            Column[] cols)
        Description copied from interface: MappingDefaults
        Fill in default information for the given discriminator columns. The columns' name and Java type will already be populated with generic defaults that may be replaced.
        Specified by:
        populateColumns in interface MappingDefaults

      • populateJoinColumn

        public void populateJoinColumn​(ClassMapping cm,
                               Table local,
                               Table foreign,
                               Column col,
                               java.lang.Object target,
                               int pos,
                               int cols)
        Description copied from interface: MappingDefaults
        Fill in default information for the given column used to join a class to its superclass table. The column will be a clone of the target column, or have its name and Java type set in the case of a constant target.
        Specified by:
        populateJoinColumn in interface MappingDefaults
        target - the target of this column in the join; may be another column or a constant value
        pos - the index of this column in the logical foreign key
        cols - the number of columns in the logical foreign key

      • populateJoinColumn

        public void populateJoinColumn​(FieldMapping fm,
                               Table local,
                               Table foreign,
                               Column col,
                               java.lang.Object target,
                               int pos,
                               int cols)
        Description copied from interface: MappingDefaults
        Fill in default information for the given column used to join a field to its defining class' table. The column will be a clone of the target column, or have its name and Java type set in the case of a constant target.
        Specified by:
        populateJoinColumn in interface MappingDefaults
        target - the target of this column in the join; may be another column or a constant value
        pos - the index of this column in the logical foreign key
        cols - the number of columns in the logical foreign key

      • populateForeignKeyColumn

        @Deprecated
public void populateForeignKeyColumn​(ValueMapping vm,
                                     java.lang.String name,
                                     Table local,
                                     Table foreign,
                                     Column col,
                                     java.lang.Object target,
                                     boolean inverse,
                                     int pos,
                                     int cols)
        Deprecated.
        Description copied from interface: MappingDefaults
        Fill in default information for the given column used to join a value to its related type. The column will be a clone of the target column, or have its name and Java type set in the case of a constant target.
        Specified by:
        populateForeignKeyColumn in interface MappingDefaults
        name - base name for value, as decided by mapping
        target - the target of this column in the join; may be another column or a constant value
        inverse - whether this is an inverse foreign key
        pos - the index of this column in the logical foreign key
        cols - the number of columns in the logical foreign key

      • populateColumns

        @Deprecated
public void populateColumns​(ValueMapping vm,
                            java.lang.String name,
                            Table table,
                            Column[] cols)
        Deprecated.
        Description copied from interface: MappingDefaults
        Fill in default information for the given value columns. The columns' name and Java type will already be populated with generic defaults that may be replaced.
        Specified by:
        populateColumns in interface MappingDefaults
        name - base name for value, as decided by mapping

      • populateOrderColumns

        public boolean populateOrderColumns​(FieldMapping fm,
                                    Table table,
                                    Column[] cols)
        Description copied from interface: MappingDefaults
        Fill in default information for the given order columns. The columns' name and Java type will already be populated with generic defaults that may be replaced.
        Specified by:
        populateOrderColumns in interface MappingDefaults
        Returns:
        false if the given field should not have order columns by default; fill in default information even when returning false in case the user forces ordering

      • populateNullIndicatorColumns

        @Deprecated
public boolean populateNullIndicatorColumns​(ValueMapping vm,
                                            java.lang.String name,
                                            Table table,
                                            Column[] cols)
        Deprecated.
        Description copied from interface: MappingDefaults
        Fill in default information for the given null indicator columns. The columns' name and Java type will already be populated with generic defaults that may be replaced.
        Specified by:
        populateNullIndicatorColumns in interface MappingDefaults
        name - base name for value, as decided by mapping
        Returns:
        false if the given value should not have null indicator columns by default; fill in default information even when returning false in case the user forces an indicator

      • getJoinForeignKey

        public ForeignKey getJoinForeignKey​(ClassMapping cls,
                                    Table local,
                                    Table foreign)
        Description copied from interface: MappingDefaults
        Return a default foreign key for the join from this class' table to its superclass' table, or null for a logical foreign key only. Do not add columns to the key or add the key to the table; only fill in its information such as name, delete action, etc.
        Specified by:
        getJoinForeignKey in interface MappingDefaults

      • getJoinForeignKey

        public ForeignKey getJoinForeignKey​(FieldMapping fm,
                                    Table local,
                                    Table foreign)
        Description copied from interface: MappingDefaults
        Return a default foreign key for the join from this field's table to its defining class' table, or null for a logical foreign key only. Do not add columns to the key or add the key to the table; only fill in its information such as name, delete action, etc.
        Specified by:
        getJoinForeignKey in interface MappingDefaults

      • getForeignKey

        @Deprecated
public ForeignKey getForeignKey​(ValueMapping vm,
                                java.lang.String name,
                                Table local,
                                Table foreign,
                                boolean inverse)
        Deprecated.
        Description copied from interface: MappingDefaults
        Return a default foreign key for the join from this value to its related type, or null for a logical foreign key only. Do not add columns to the key or add the key to the table; only fill in its information such as name, delete action, etc.
        Specified by:
        getForeignKey in interface MappingDefaults
        name - base name for value, as decided by mapping
        inverse - whether this is an inverse key

      • getJoinIndex

        public Index getJoinIndex​(FieldMapping fm,
                          Table table,
                          Column[] cols)
        Description copied from interface: MappingDefaults
        Return a default index for the join, or null if the join columns should not be indexed by default. Do not add columns to the index or add the index to the table; only fill in its information such as name, uniqueness, etc.
        Specified by:
        getJoinIndex in interface MappingDefaults

      • getIndex

        public Index getIndex​(ValueMapping vm,
                      java.lang.String name,
                      Table table,
                      Column[] cols)
        Description copied from interface: MappingDefaults
        Return a default index for the value, or null if the value columns should not be indexed by default. Do not add columns to the index or add the index to the table; only fill in its information such as name, uniqueness, etc.
        Specified by:
        getIndex in interface MappingDefaults
        name - base name for value, as decided by mapping

      • getIndex

        public Index getIndex​(Version vers,
                      Table table,
                      Column[] cols)
        Description copied from interface: MappingDefaults
        Return a default index for the version, or null if the version columns should not be indexed by default. Do not add columns to the index or add the index to the table; only fill in its information such as name, uniqueness, etc.
        Specified by:
        getIndex in interface MappingDefaults

      • getIndex

        public Index getIndex​(Discriminator disc,
                      Table table,
                      Column[] cols)
        Description copied from interface: MappingDefaults
        Return a default index for the discriminator, or null if the discriminator columns should not be indexed by default. Do not add columns to the index or add the index to the table; only fill in its information such as name, uniqueness, etc.
        Specified by:
        getIndex in interface MappingDefaults

      • getJoinUnique

        public Unique getJoinUnique​(FieldMapping fm,
                            Table table,
                            Column[] cols)
        Description copied from interface: MappingDefaults
        Return a default constraint for the join, or null if the join columns should not be constrained by default. Do not add columns to the constraint or add the constraint to the table; only fill in its information such as name, deferrability, etc.
        Specified by:
        getJoinUnique in interface MappingDefaults

      • getUnique

        public Unique getUnique​(ValueMapping vm,
                        java.lang.String name,
                        Table table,
                        Column[] cols)
        Description copied from interface: MappingDefaults
        Return a default constraint for the value, or null if the value columns should not be constrained by default. Do not add columns to the constraint or add the constraint to the table; only fill in its information such as name, deferrability, etc.
        Specified by:
        getUnique in interface MappingDefaults
        name - base name for value, as decided by mapping

      • getForeignKey

        public ForeignKey getForeignKey​(ValueMapping vm,
                                DBIdentifier name,
                                Table local,
                                Table foreign,
                                boolean inverse)
        Description copied from interface: MappingDefaults
        Return a default foreign key for the join from this value to its related type, or null for a logical foreign key only. Do not add columns to the key or add the key to the table; only fill in its information such as name, delete action, etc.
        Specified by:
        getForeignKey in interface MappingDefaults
        name - base name for value, as decided by mapping
        inverse - whether this is an inverse key

      • getIndex

        public Index getIndex​(ValueMapping vm,
                      DBIdentifier name,
                      Table table,
                      Column[] cols)
        Description copied from interface: MappingDefaults
        Return a default index for the value, or null if the value columns should not be indexed by default. Do not add columns to the index or add the index to the table; only fill in its information such as name, uniqueness, etc.
        Specified by:
        getIndex in interface MappingDefaults
        name - base name for value, as decided by mapping

      • getUnique

        public Unique getUnique​(ValueMapping vm,
                        DBIdentifier name,
                        Table table,
                        Column[] cols)
        Description copied from interface: MappingDefaults
        Return a default constraint for the value, or null if the value columns should not be constrained by default. Do not add columns to the constraint or add the constraint to the table; only fill in its information such as name, deferrability, etc.
        Specified by:
        getUnique in interface MappingDefaults
        name - base name for value, as decided by mapping

      • populateColumns

        public void populateColumns​(ValueMapping vm,
                            DBIdentifier name,
                            Table table,
                            Column[] cols)
        Description copied from interface: MappingDefaults
        Fill in default information for the given value columns. The columns' name and Java type will already be populated with generic defaults that may be replaced.
        Specified by:
        populateColumns in interface MappingDefaults
        name - base name for value, as decided by mapping

      • populateForeignKeyColumn

        public void populateForeignKeyColumn​(ValueMapping vm,
                                     DBIdentifier name,
                                     Table local,
                                     Table foreign,
                                     Column col,
                                     java.lang.Object target,
                                     boolean inverse,
                                     int pos,
                                     int cols)
        Description copied from interface: MappingDefaults
        Fill in default information for the given column used to join a value to its related type. The column will be a clone of the target column, or have its name and Java type set in the case of a constant target.
        Specified by:
        populateForeignKeyColumn in interface MappingDefaults
        name - base name for value, as decided by mapping
        target - the target of this column in the join; may be another column or a constant value
        inverse - whether this is an inverse foreign key
        pos - the index of this column in the logical foreign key
        cols - the number of columns in the logical foreign key

      • populateNullIndicatorColumns

        public boolean populateNullIndicatorColumns​(ValueMapping vm,
                                            DBIdentifier name,
                                            Table table,
                                            Column[] cols)
        Description copied from interface: MappingDefaults
        Fill in default information for the given null indicator columns. The columns' name and Java type will already be populated with generic defaults that may be replaced.
        Specified by:
        populateNullIndicatorColumns in interface MappingDefaults
        name - base name for value, as decided by mapping
        Returns:
        false if the given value should not have null indicator columns by default; fill in default information even when returning false in case the user forces an indicator