| java.lang.Object
 org.netbeans.modules.sql.framework.model.impl.ForeignKeyImpl
| ForeignKeyImpl | | public class ForeignKeyImpl implements Cloneable,ForeignKey(Code) | | Implements ForeignKey interface.
author:
Jonathan Giron
version:
$Revision$ |
| Constructor Summary | |
| public | ForeignKeyImpl(DBTable fkTable, String foreignKeyName, String primaryKeyName, String primaryKeyTable, String primaryKeySchema, String primaryKeyCatalog, int updateFlag, int deleteFlag, int deferFlag)
Creates a new instance of ForeignKey with the given key name and referencing the
column names in the given List. | | public | ForeignKeyImpl(Element keyElement)
Creates a new instance of ForeignKeyImpl, using the keyElement as a source for
reconstituting its contents. | | public | ForeignKeyImpl(ForeignKey src)
Creates a new instance of ForeignKeyImpl, cloning the contents of the given
ForeignKey implementation instance. |
| Method Summary | |
| public void | addColumnNames(ResultSet rs)
| | public Object | clone()
Create a clone of this PrimaryKeyImpl. | | public boolean | contains(DBColumn fkCol)
| | public boolean | contains(String fkColumnName)
| | public static Map<String, ForeignKey> | createForeignKeyColumnMap(DBTable table, ResultSet rs)
Creates a List of ForeignKeyColumn instances from the given ResultSet. | | public boolean | equals(Object refObj)
Overrides default implementation to return value based on memberwise comparison. | | public int | getColumnCount()
| | public String | getColumnName(int iColumn)
| | public List<String> | getColumnNames()
| | public int | getDeferrability()
| | public int | getDeleteRule()
| | public String | getMatchingPKColumn(String fkColumnName)
| | public String | getName()
| | public String | getPKCatalog()
| | public List<String> | getPKColumnNames()
| | public String | getPKName()
| | public String | getPKSchema()
| | public String | getPKTable()
| | public DBTable | getParent()
| | public int | getSequence(DBColumn col)
| | public int | getUpdateRule()
| | public int | hashCode()
Overrides default implementation to compute hashCode value for those members used
in equals() for comparison. | | public void | parseXML()
Parses the XML content, if any, represented by the DOM element member varaible. | | public boolean | references(DBTable aTable)
| | public boolean | references(PrimaryKey pk)
| | public boolean | references(String pkTableName, String pkSchemaName, String pkCatalogName)
| | public void | setColumnNames(List fkColumns, List pkColumns)
Sets names of columns participating in this ForeignKeyImpl, using the given Lists
of foreign key column names and corresponding names of primary key columns. | | public void | setParent(DBTable newParent)
Sets reference to DBTable that owns this foreign key. | | public synchronized String | toXMLString()
Writes contents of this PrimaryKeyImpl instance out as an XML element, using the
default prefix. | | public synchronized String | toXMLString(String prefix)
Writes contents of this PrimaryKeyImpl instance out as an XML element, using the
given prefix String. |
| ELEMENT_TAG | | final public static String ELEMENT_TAG(Code) | | Document element tag name for marshalling out this object to XML
|
| FK_COLUMNS_ATTR | | final public static String FK_COLUMNS_ATTR(Code) | | Name of attribute used for marshalling out FK column names to XML
|
| FK_NAME_ATTR | | final public static String FK_NAME_ATTR(Code) | | Name of attribute used for marshalling out FK name to XML
|
| PK_CATALOG_ATTR | | final public static String PK_CATALOG_ATTR(Code) | | Name of attribute used for marshalling out catalog name of PK table to XML
|
| PK_COLUMNS_ATTR | | final public static String PK_COLUMNS_ATTR(Code) | | Name of attribute used for marshalling out PK column names to XML
|
| PK_DEFER_ATTR | | final public static String PK_DEFER_ATTR(Code) | | Name of attribute used for marshalling out deferrability rule to XML
|
| PK_DELETE_ATTR | | final public static String PK_DELETE_ATTR(Code) | | Name of attribute used for marshalling out delete rule to XML
|
| PK_NAME_ATTR | | final public static String PK_NAME_ATTR(Code) | | Name of attribute used for marshalling out PK name to XML
|
| PK_SCHEMA_ATTR | | final public static String PK_SCHEMA_ATTR(Code) | | Name of attribute used for marshalling out schema name of PK table to XML
|
| PK_TABLE_ATTR | | final public static String PK_TABLE_ATTR(Code) | | Name of attribute used for marshalling out PK table name to XML
|
| PK_UPDATE_ATTR | | final public static String PK_UPDATE_ATTR(Code) | | Name of attribute used for marshalling out update rule to XML
|
| ForeignKeyImpl | | public ForeignKeyImpl(DBTable fkTable, String foreignKeyName, String primaryKeyName, String primaryKeyTable, String primaryKeySchema, String primaryKeyCatalog, int updateFlag, int deleteFlag, int deferFlag)(Code) | | Creates a new instance of ForeignKey with the given key name and referencing the
column names in the given List.
Parameters:
fkTable - DBTable that owns this FK instance
Parameters:
foreignKeyName - name, if any, of this ForeignKeyImpl
Parameters:
primaryKeyName - name, if any, of PK associated with this ForeignKeyImpl
Parameters:
primaryKeyTable - table owning associated PK
Parameters:
primaryKeySchema - schema containing table which owns associated PK; may benull
Parameters:
primaryKeyCatalog - catalog containing table which owns associated PK; may benull
Parameters:
updateFlag - update cascade rule
Parameters:
deleteFlag - delete cascade rule
Parameters:
deferFlag - flag indicating deferrability of application of cascade rules |
| ForeignKeyImpl | | public ForeignKeyImpl(Element keyElement)(Code) | | Creates a new instance of ForeignKeyImpl, using the keyElement as a source for
reconstituting its contents. Caller must invoke parseXml() after this constructor
returns in order to unmarshal and reconstitute the instance object.
Parameters:
keyElement - DOM element containing XML marshalled version of a ForeignKeyImplinstance |
| ForeignKeyImpl | | public ForeignKeyImpl(ForeignKey src)(Code) | | Creates a new instance of ForeignKeyImpl, cloning the contents of the given
ForeignKey implementation instance.
Parameters:
src - ForeignKey to be cloned |
| clone | | public Object clone()(Code) | | Create a clone of this PrimaryKeyImpl.
cloned copy of DBColumn. |
| contains | | public boolean contains(DBColumn fkCol)(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.contains |
| contains | | public boolean contains(String fkColumnName)(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.contains(java.lang.String) |
| createForeignKeyColumnMap | | public static Map<String, ForeignKey> createForeignKeyColumnMap(DBTable table, ResultSet rs) throws SQLException(Code) | | Creates a List of ForeignKeyColumn instances from the given ResultSet.
Parameters:
rs - ResultSet containing foreign key metadata as obtained from DatabaseMetaData List of ForeignKeyColumn instances based from metadata in rs
throws:
SQLException - if SQL error occurs while reading in data fromgiven ResultSet |
| equals | | public boolean equals(Object refObj)(Code) | | Overrides default implementation to return value based on memberwise comparison.
Parameters:
refObj - Object against which we compare this instance true if refObj is functionally identical to this instance; false otherwise |
| getColumnCount | | public int getColumnCount()(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.getColumnCount |
| getColumnName | | public String getColumnName(int iColumn)(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.getColumnName |
| getColumnNames | | public List<String> getColumnNames()(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.getColumnNames |
| getDeferrability | | public int getDeferrability()(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.getDeferrability |
| getDeleteRule | | public int getDeleteRule()(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.getDeleteRule |
| getMatchingPKColumn | | public String getMatchingPKColumn(String fkColumnName)(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.getMatchingPKColumn |
| getName | | public String getName()(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.getName |
| getPKCatalog | | public String getPKCatalog()(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.getPKCatalog |
| getPKColumnNames | | public List<String> getPKColumnNames()(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.getPKColumnNames |
| getPKName | | public String getPKName()(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.getPKName |
| getPKSchema | | public String getPKSchema()(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.getPKSchema |
| getPKTable | | public String getPKTable()(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.getPKTable |
| getParent | | public DBTable getParent()(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.getParent |
| getSequence | | public int getSequence(DBColumn col)(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.getSequence |
| getUpdateRule | | public int getUpdateRule()(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.getUpdateRule |
| hashCode | | public int hashCode()(Code) | | Overrides default implementation to compute hashCode value for those members used
in equals() for comparison.
hash code for this object
See Also: java.lang.Object.hashCode |
| parseXML | | public void parseXML() throws BaseException(Code) | | Parses the XML content, if any, represented by the DOM element member varaible.
exception:
BaseException - thrown while parsing XML, or if member variable element isnull |
| references | | public boolean references(DBTable aTable)(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.references |
| references | | public boolean references(PrimaryKey pk)(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.references |
| references | | public boolean references(String pkTableName, String pkSchemaName, String pkCatalogName)(Code) | |
See Also: org.netbeans.modules.model.database.ForeignKey.references |
| setColumnNames | | public void setColumnNames(List fkColumns, List pkColumns)(Code) | | Sets names of columns participating in this ForeignKeyImpl, using the given Lists
of foreign key column names and corresponding names of primary key columns.
Parameters:
fkColumns - List of Strings representing the names of columns that are part ofthis ForeignKey, in sequential order.
Parameters:
pkColumns - List of Strings representing the names of corresponding primarykey columns, in sequential order.
See Also: org.netbeans.modules.sql.framework.model.impl.ForeignKeyImpl.Column |
| setParent | | public void setParent(DBTable newParent)(Code) | | Sets reference to DBTable that owns this foreign key.
Parameters:
newParent - new parent of this foreign key. |
| toXMLString | | public synchronized String toXMLString()(Code) | | Writes contents of this PrimaryKeyImpl instance out as an XML element, using the
default prefix.
String containing XML representation of this PrimaryKeyImpl instance |
| toXMLString | | public synchronized String toXMLString(String prefix)(Code) | | Writes contents of this PrimaryKeyImpl instance out as an XML element, using the
given prefix String.
Parameters:
prefix - String used to prefix each new line of the XML output String containing XML representation of this PrimaryKeyImpl instance |
|
|