/*
Derby - Class org.apache.derby.impl.sql.catalog.SYSFOREIGNKEYSRowFactory
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to you under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package org.apache.derby.impl.sql.catalog;
import org.apache.derby.catalog.UUID;
import org.apache.derby.iapi.error.StandardException;
import org.apache.derby.iapi.services.sanity.SanityManager;
import org.apache.derby.iapi.services.uuid.UUIDFactory;
import org.apache.derby.iapi.sql.StatementType;
import org.apache.derby.iapi.sql.dictionary.CatalogRowFactory;
import org.apache.derby.iapi.sql.dictionary.DataDescriptorGenerator;
import org.apache.derby.iapi.sql.dictionary.DataDictionary;
import org.apache.derby.iapi.sql.dictionary.ForeignKeyConstraintDescriptor;
import org.apache.derby.iapi.sql.dictionary.ReferencedKeyConstraintDescriptor;
import org.apache.derby.iapi.sql.dictionary.SubKeyConstraintDescriptor;
import org.apache.derby.iapi.sql.dictionary.SystemColumn;
import org.apache.derby.iapi.sql.dictionary.TupleDescriptor;
import org.apache.derby.iapi.sql.execute.ExecIndexRow;
import org.apache.derby.iapi.sql.execute.ExecRow;
import org.apache.derby.iapi.sql.execute.ExecutionFactory;
import org.apache.derby.iapi.types.DataValueDescriptor;
import org.apache.derby.iapi.types.DataValueFactory;
import org.apache.derby.iapi.types.SQLChar;
/**
* Factory for creating a SYSFOREIGNKEYS row.
*
*/
public class SYSFOREIGNKEYSRowFactory extends CatalogRowFactory
{
private static final String TABLENAME_STRING = "SYSFOREIGNKEYS";
protected static final int SYSFOREIGNKEYS_COLUMN_COUNT = 5;
protected static final int SYSFOREIGNKEYS_CONSTRAINTID = 1;
protected static final int SYSFOREIGNKEYS_CONGLOMERATEID = 2;
protected static final int SYSFOREIGNKEYS_KEYCONSTRAINTID = 3;
protected static final int SYSFOREIGNKEYS_DELETERULE = 4;
protected static final int SYSFOREIGNKEYS_UPDATERULE = 5;
// Column widths
protected static final int SYSFOREIGNKEYS_CONSTRAINTID_WIDTH = 36;
protected static final int SYSFOREIGNKEYS_INDEX1_ID = 0;
protected static final int SYSFOREIGNKEYS_INDEX2_ID = 1;
private static final int[][] indexColumnPositions =
{
{SYSFOREIGNKEYS_CONSTRAINTID},
{SYSFOREIGNKEYS_KEYCONSTRAINTID}
};
private static final boolean[] uniqueness = {
true,
false
};
private static final String[] uuids =
{
"8000005b-00d0-fd77-3ed8-000a0a0b1900" // catalog UUID
,"80000060-00d0-fd77-3ed8-000a0a0b1900" // heap UUID
,"8000005d-00d0-fd77-3ed8-000a0a0b1900" // SYSFOREIGNKEYS_INDEX1
,"8000005f-00d0-fd77-3ed8-000a0a0b1900" // SYSFOREIGNKEYS_INDEX2
};
/////////////////////////////////////////////////////////////////////////////
//
// CONSTRUCTORS
//
/////////////////////////////////////////////////////////////////////////////
public SYSFOREIGNKEYSRowFactory(UUIDFactory uuidf, ExecutionFactory ef, DataValueFactory dvf,
boolean convertIdToLower)
{
super(uuidf,ef,dvf,convertIdToLower);
initInfo(SYSFOREIGNKEYS_COLUMN_COUNT, TABLENAME_STRING,
indexColumnPositions, uniqueness, uuids );
}
/////////////////////////////////////////////////////////////////////////////
//
// METHODS
//
/////////////////////////////////////////////////////////////////////////////
/**
* Make a SYSFOREIGNKEYS row
*
* @return Row suitable for inserting into SYSFOREIGNKEYS.
*
* @exception StandardException thrown on failure
*/
public ExecRow makeRow(TupleDescriptor td, TupleDescriptor parent)
throws StandardException
{
DataValueDescriptor col;
ExecIndexRow row;
String constraintId = null;
String keyConstraintId = null;
String conglomId = null;
String raDeleteRule="N";
String raUpdateRule="N";
if (td != null)
{
ForeignKeyConstraintDescriptor cd = (ForeignKeyConstraintDescriptor)td;
constraintId = cd.getUUID().toString();
ReferencedKeyConstraintDescriptor refCd = cd.getReferencedConstraint();
if (SanityManager.DEBUG)
{
SanityManager.ASSERT(refCd != null, "this fk returned a null referenced key");
}
keyConstraintId = refCd.getUUID().toString();
conglomId = cd.getIndexUUIDString();
raDeleteRule = getRefActionAsString(cd.getRaDeleteRule());
raUpdateRule = getRefActionAsString(cd.getRaUpdateRule());
}
/* Build the row */
row = getExecutionFactory().getIndexableRow(SYSFOREIGNKEYS_COLUMN_COUNT);
/* 1st column is CONSTRAINTID (UUID - char(36)) */
row.setColumn(SYSFOREIGNKEYS_CONSTRAINTID, new SQLChar(constraintId));
/* 2nd column is CONGLOMERATEID (UUID - char(36)) */
row.setColumn(SYSFOREIGNKEYS_CONGLOMERATEID, new SQLChar(conglomId));
/* 3rd column is KEYCONSTRAINTID (UUID - char(36)) */
row.setColumn(SYSFOREIGNKEYS_KEYCONSTRAINTID, new SQLChar(keyConstraintId));
// currently, DELETERULE and UPDATERULE are always "R" for restrict
/* 4th column is DELETERULE char(1) */
row.setColumn(SYSFOREIGNKEYS_DELETERULE, new SQLChar(raDeleteRule));
/* 5th column is UPDATERULE char(1) */
row.setColumn(SYSFOREIGNKEYS_UPDATERULE, new SQLChar(raUpdateRule));
return row;
}
///////////////////////////////////////////////////////////////////////////
//
// ABSTRACT METHODS TO BE IMPLEMENTED BY CHILDREN OF CatalogRowFactory
//
///////////////////////////////////////////////////////////////////////////
/**
* Make a ViewDescriptor out of a SYSFOREIGNKEYS row
*
* @param row a SYSFOREIGNKEYS row
* @param parentTupleDescriptor Null for this kind of descriptor.
* @param dd dataDictionary
*
* @exception StandardException thrown on failure
*/
public TupleDescriptor buildDescriptor(
ExecRow row,
TupleDescriptor parentTupleDescriptor,
DataDictionary dd )
throws StandardException
{
if (SanityManager.DEBUG)
{
SanityManager.ASSERT(
row.nColumns() == SYSFOREIGNKEYS_COLUMN_COUNT,
"Wrong number of columns for a SYSKEYS row");
}
DataValueDescriptor col;
DataDescriptorGenerator ddg;
UUID constraintUUID;
UUID conglomerateUUID;
UUID keyConstraintUUID;
String constraintUUIDString;
String conglomerateUUIDString;
String raRuleString;
int raDeleteRule;
int raUpdateRule;
ddg = dd.getDataDescriptorGenerator();
/* 1st column is CONSTRAINTID (UUID - char(36)) */
col = row.getColumn(SYSFOREIGNKEYS_CONSTRAINTID);
constraintUUIDString = col.getString();
constraintUUID = getUUIDFactory().recreateUUID(constraintUUIDString);
/* 2nd column is CONGLOMERATEID (UUID - char(36)) */
col = row.getColumn(SYSFOREIGNKEYS_CONGLOMERATEID);
conglomerateUUIDString = col.getString();
conglomerateUUID = getUUIDFactory().recreateUUID(conglomerateUUIDString);
/* 3rd column is KEYCONSTRAINTID (UUID - char(36)) */
col = row.getColumn(SYSFOREIGNKEYS_KEYCONSTRAINTID);
constraintUUIDString = col.getString();
keyConstraintUUID = getUUIDFactory().recreateUUID(constraintUUIDString);
/* 4th column is DELETERULE char(1) */
col= row.getColumn(SYSFOREIGNKEYS_DELETERULE);
raRuleString = col.getString();
raDeleteRule = getRefActionAsInt(raRuleString);
/* 5th column is UPDATERULE char(1) */
col = row.getColumn(SYSFOREIGNKEYS_UPDATERULE);
raRuleString = col.getString();
raUpdateRule = getRefActionAsInt(raRuleString);
/* now build and return the descriptor */
return new SubKeyConstraintDescriptor(
constraintUUID,
conglomerateUUID,
keyConstraintUUID,
raDeleteRule,
raUpdateRule);
}
/**
* Builds a list of columns suitable for creating this Catalog.
*
*
* @return array of SystemColumn suitable for making this catalog.
*/
public SystemColumn[] buildColumnList()
{
int index = 0;
SystemColumn[] columnList = new SystemColumn[SYSFOREIGNKEYS_COLUMN_COUNT];
// describe columns
columnList[index++] = new SystemColumnImpl(
convertIdCase( "CONSTRAINTID"), // name
SYSFOREIGNKEYS_CONSTRAINTID, // column number
0, // precision
0, // scale
false, // nullability
"CHAR", // dataType
true, // built-in type
36 // maxLength
);
columnList[index++] = new SystemColumnImpl(
convertIdCase( "CONGLOMERATEID"), // name
SYSFOREIGNKEYS_CONGLOMERATEID, // column number
0, // precision
0, // scale
false, // nullability
"CHAR", // dataType
true, // built-in type
36 // maxLength
);
columnList[index++] = new SystemColumnImpl(
convertIdCase( "KEYCONSTRAINTID"), // name
SYSFOREIGNKEYS_KEYCONSTRAINTID, // column number
0, // precision
0, // scale
false, // nullability
"CHAR", // dataType
true, // built-in type
36 // maxLength
);
columnList[index++] = new SystemColumnImpl(
convertIdCase( "DELETERULE"), // name
SYSFOREIGNKEYS_DELETERULE, // column number
0, // precision
0, // scale
false, // nullability
"CHAR", // dataType
true, // built-in type
1 // maxLength
);
columnList[index++] = new SystemColumnImpl(
convertIdCase( "UPDATERULE"), // name
SYSFOREIGNKEYS_UPDATERULE, // column number
0, // precision
0, // scale
false, // nullability
"CHAR", // dataType
true, // built-in type
1 // maxLength
);
return columnList;
}
int getRefActionAsInt(String raRuleString)
{
int raRule ;
switch (raRuleString.charAt(0)){
case 'C':
raRule = StatementType.RA_CASCADE;
break;
case 'S':
raRule = StatementType.RA_RESTRICT;
break;
case 'R':
raRule = StatementType.RA_NOACTION;
break;
case 'U':
raRule = StatementType.RA_SETNULL;
break;
case 'D':
raRule = StatementType.RA_SETDEFAULT;
break;
default:
raRule =StatementType.RA_NOACTION; ;
if (SanityManager.DEBUG)
{
SanityManager.THROWASSERT("Invalid value '"
+raRuleString+ "' for a referetial Action");
}
}
return raRule ;
}
String getRefActionAsString(int raRule)
{
String raRuleString ;
switch (raRule){
case StatementType.RA_CASCADE:
raRuleString = "C";
break;
case StatementType.RA_RESTRICT:
raRuleString = "S";
break;
case StatementType.RA_NOACTION:
raRuleString = "R";
break;
case StatementType.RA_SETNULL:
raRuleString = "U";
break;
case StatementType.RA_SETDEFAULT:
raRuleString = "D";
raRule = StatementType.RA_SETDEFAULT;
break;
default:
raRuleString ="N" ; // NO ACTION (default value)
if (SanityManager.DEBUG)
{
SanityManager.THROWASSERT("Invalid value '"
+raRule+ "' for a referetial Action");
}
}
return raRuleString ;
}
}