Package org.apache.openjpa.jdbc.meta

Class ClassMappingInfo

    • Constructor Detail

      • ClassMappingInfo

        public ClassMappingInfo()

    • Method Detail

      • getClassName

        public String getClassName()
        The described class name.

      • setClassName

        public void setClassName​(String name)
        The described class name.

      • getHierarchyStrategy

        public String getHierarchyStrategy()
        The default strategy for subclasses in this hierarchy.

      • setHierarchyStrategy

        public void setHierarchyStrategy​(String strategy)
        The default strategy for subclasses in this hierarchy.

      • getTableName

        @Deprecated
public String getTableName()
        Deprecated.
        The given table name.

      • getTableIdentifier

        public DBIdentifier getTableIdentifier()

      • setTableName

        @Deprecated
public void setTableName​(String table)
        Deprecated.
        The given table name.

      • setTableIdentifier

        public void setTableIdentifier​(DBIdentifier table)

      • getSchemaName

        @Deprecated
public String getSchemaName()
        Deprecated.
        The default schema name for unqualified tables.

      • getSchemaIdentifier

        public DBIdentifier getSchemaIdentifier()

      • setSchemaName

        @Deprecated
public void setSchemaName​(String schema)
        Deprecated.
        The default schema name for unqualified tables.

      • setSchemaIdentifier

        public void setSchemaIdentifier​(DBIdentifier schema)

      • isJoinedSubclass

        public boolean isJoinedSubclass()
        Whether there is a join to the superclass table.

      • setJoinedSubclass

        public void setJoinedSubclass​(boolean joined)
        Whether there is a join to the superclass table.

      • getSecondaryTableNames

        @Deprecated
public String[] getSecondaryTableNames()
        Deprecated.
        Return the class-level joined tables.

      • getSecondaryTableIdentifiers

        public DBIdentifier[] getSecondaryTableIdentifiers()

      • getSecondaryTableName

        @Deprecated
public String getSecondaryTableName​(String tableName)
        Deprecated.
        We allow fields to reference class-level joins using just the table name, whereas the class join might have schema, etc information. This method returns the name of the given table as listed in a class-level join, or the given name if no join exists.

      • getSecondaryTableJoinColumns

        @Deprecated
public List<Column> getSecondaryTableJoinColumns​(String tableName)
        Deprecated.
        Return any columns defined for the given class level join, or empty list if none.

      • addSecondaryTable

        @Deprecated
public void addSecondaryTable​(String second)
        Deprecated.
        Adds a Secondary table of given name to this mapping. A secondary table must be known before unique constraints are added to a Secondary table.

      • addSecondaryTable

        public void addSecondaryTable​(DBIdentifier second)

      • setSecondaryTableJoinColumns

        @Deprecated
public void setSecondaryTableJoinColumns​(String tableName,
                                         List<Column> cols)
        Deprecated.
        Declare the given class-level join to the named (secondary) table.

      • setSecondaryTableJoinColumns

        public void setSecondaryTableJoinColumns​(DBIdentifier tableName,
                                         List<Column> cols)

      • getTable

        public Table getTable​(ClassMapping cls,
                      boolean adapt)
        Return the primary table for the given class.

      • getDataStoreIdColumns

        public Column[] getDataStoreIdColumns​(ClassMapping cls,
                                      Column[] tmplates,
                                      Table table,
                                      boolean adapt)
        Return the datastore identity columns for the given class, based on the given templates.

      • getSuperclassJoin

        public ForeignKey getSuperclassJoin​(ClassMapping cls,
                                    Table table,
                                    boolean adapt)
        Return the join from this class to its superclass. The table for this class must be set.

      • syncWith

        public void syncWith​(ClassMapping cls)
        Synchronize internal information with the mapping data for the given class.

      • hasSchemaComponents

        public boolean hasSchemaComponents()
        Description copied from class: MappingInfo
        Return true if this info has columns, foreign key information, index information, etc.
        Overrides:
        hasSchemaComponents in class MappingInfo

      • clear

        protected void clear​(boolean canFlags)
        Description copied from class: MappingInfo
        Clear mapping information.
        Overrides:
        clear in class MappingInfo
        Parameters:
        canFlags - whether to clear information about whether we can place indexed, foreign keys, etc on this mapping

      • addUnique

        @Deprecated
public void addUnique​(String table,
                      Unique unique)
        Deprecated.
        Add a unique constraint for the given table.
        Parameters:
        table - must be primary table or secondary table name added a priori to this receiver.
        unique - the unique constraint. null means no-op.

      • addUnique

        public void addUnique​(DBIdentifier table,
                      Unique unique)
        Add a unique constraint for the given table.
        Parameters:
        table - must be primary table or secondary table name added a priori to this receiver.
        unique - the unique constraint. null means no-op.

      • addIndex

        public void addIndex​(DBIdentifier table,
                     Index idx)
        Add index for the given table.
        Parameters:
        table - must be primary table or secondary table name added a priori to this receiver.
        idx - the index. null means no-op.

      • getUniques

        @Deprecated
public Unique[] getUniques​(String table)
        Deprecated.
        Get the unique constraints of the given primary or secondary table.

      • getUniques

        public Unique[] getUniques​(DBIdentifier table)
        Get the unique constraints of the given primary or secondary table.

      • getUniques

        public Unique[] getUniques​(MetaDataContext cm,
                           boolean adapt)
        Get all the unique constraints associated with both the primary and/or secondary tables.

      • getIndices

        public Index[] getIndices​(MetaDataContext cm,
                          boolean adapt)
        Get all indices associated with both the primary and/or secondary tables.

      • setSource

        public void setSource​(File file,
                      int srcType)

      • getResourceName

        public String getResourceName()
        Description copied from interface: SourceTracker
        Return the domain-meaningful name of the resource that was loaded from this source. I.e., if we had loaded the source for a Java class, this would return the name of the class.
        Specified by:
        getResourceName in interface SourceTracker

      • getLineNumber

        public int getLineNumber()
        Description copied from interface: SourceTracker
        Return the line number of the file at which this instance was parsed.
        Specified by:
        getLineNumber in interface SourceTracker

      • setLineNumber

        public void setLineNumber​(int lineNum)

      • getColNumber

        public int getColNumber()
        Description copied from interface: SourceTracker
        Return the column number in the line of the file at which this instance was parsed.
        Specified by:
        getColNumber in interface SourceTracker

      • setColNumber

        public void setColNumber​(int colNum)