-
- All Known Subinterfaces:
- CachedRowSet, FilteredRowSet, JdbcRowSet, JoinRowSet, WebRowSet
public interface Joinable
1.0 Background
TheJoinable
interface provides the methods for getting and setting a match column, which is the basis for forming the SQLJOIN
formed by addingRowSet
objects to aJoinRowSet
object.Any standard
RowSet
implementation may implement theJoinable
interface in order to be added to aJoinRowSet
object. Implementing this interface gives aRowSet
object the ability to useJoinable
methods, which set, retrieve, and get information about match columns. An application may add aRowSet
object that has not implemented theJoinable
interface to aJoinRowSet
object, but to do so it must use one of theJoinRowSet.addRowSet
methods that takes both aRowSet
object and a match column or an array ofRowSet
objects and an array of match columns.To get access to the methods in the
Joinable
interface, aRowSet
object implements at least one of the five standardRowSet
interfaces and also implements theJoinable
interface. In addition, mostRowSet
objects extend theBaseRowSet
class. For example:class MyRowSetImpl extends BaseRowSet implements CachedRowSet, Joinable { : : }
2.0 Usage Guidelines
The methods in the
Joinable
interface allow aRowSet
object to set a match column, retrieve a match column, or unset a match column, which is the column upon which an SQLJOIN
can be based. An instance of a class that implements these methods can be added to aJoinRowSet
object to allow an SQLJOIN
relationship to be established.CachedRowSet crs = new MyRowSetImpl(); crs.populate((ResultSet)rs); (Joinable)crs.setMatchColumnIndex(1); JoinRowSet jrs = new JoinRowSetImpl(); jrs.addRowSet(crs);
In the previous example, crs is aCachedRowSet
object that has emplemented theJoinable
interface. In the following example, crs2 has not, so it must supply the match column as an argument to theaddRowSet
method. This example assumes that column 1 is the match column.CachedRowSet crs2 = new MyRowSetImpl(); crs2.populate((ResultSet)rs); JoinRowSet jrs2 = new JoinRowSetImpl(); jrs2.addRowSet(crs2, 1);
The
JoinRowSet
interface makes it possible to get data from one or moreRowSet
objects consolidated into one table without having to incur the expense of creating a connection to a database. It is therefore ideally suited for use by disconnectedRowSet
objects. Nevertheless, anyRowSet
object may implement this interface regardless of whether it is connected or disconnected. Note that aJdbcRowSet
object, being always connected to its data source, can become part of an SQLJOIN
directly without having to become part of aJoinRowSet
object.3.0 Managing Multiple Match Columns
The index array passed into thesetMatchColumn
methods indicates how many match columns are being set (the length of the array) in addition to which columns will be used for the match. For example:int[] i = {1, 2, 4, 7}; // indicates four match columns, with column // indexes 1, 2, 4, 7 participating in the JOIN. Joinable.setMatchColumn(i);
Subsequent match columns may be added as follows to a differentJoinable
object (aRowSet
object that has implemented theJoinable
interface).int[] w = {3, 2, 5, 3}; Joinable2.setMatchColumn(w);
When an application adds two or moreRowSet
objects to aJoinRowSet
object, the order of the indexes in the array is particularly important. Each index of the array maps directly to the corresponding index of the previously addedRowSet
object. If overlap or underlap occurs, the match column data is maintained in the event an additionalJoinable
RowSet is added and needs to relate to the match column data. Therefore, applications can set multiple match columns in any order, but this order has a direct effect on the outcome of theSQL
JOIN.This assertion applies in exactly the same manner when column names are used rather than column indexes to indicate match columns.
- See Also:
JoinRowSet
-
-
Method Summary
Methods Modifier and Type Method and Description int[]
getMatchColumnIndexes()
Retrieves the indexes of the match columns that were set for thisRowSet
object with the methodsetMatchColumn(int[] columnIdxes)
.String[]
getMatchColumnNames()
Retrieves the names of the match columns that were set for thisRowSet
object with the methodsetMatchColumn(String [] columnNames)
.void
setMatchColumn(int columnIdx)
Sets the designated column as the match column for thisRowSet
object.void
setMatchColumn(int[] columnIdxes)
Sets the designated columns as the match column for thisRowSet
object.void
setMatchColumn(String columnName)
Sets the designated column as the match column for thisRowSet
object.void
setMatchColumn(String[] columnNames)
Sets the designated columns as the match column for thisRowSet
object.void
unsetMatchColumn(int columnIdx)
Unsets the designated column as the match column for thisRowSet
object.void
unsetMatchColumn(int[] columnIdxes)
Unsets the designated columns as the match column for thisRowSet
object.void
unsetMatchColumn(String columnName)
Unsets the designated column as the match column for thisRowSet
object.void
unsetMatchColumn(String[] columnName)
Unsets the designated columns as the match columns for thisRowSet
object.
-
-
-
Method Detail
-
setMatchColumn
void setMatchColumn(int columnIdx) throws SQLException
Sets the designated column as the match column for thisRowSet
object. AJoinRowSet
object can now add thisRowSet
object based on the match column.Sub-interfaces such as the
CachedRowSet
TM interface define the methodCachedRowSet.setKeyColumns
, which allows primary key semantics to be enforced on specific columns. Implementations of thesetMatchColumn(int columnIdx)
method should ensure that the constraints on the key columns are maintained when aCachedRowSet
object sets a primary key column as a match column.- Parameters:
columnIdx
- anint
identifying the index of the column to be set as the match column- Throws:
SQLException
- if an invalid column index is set- See Also:
setMatchColumn(int[])
,unsetMatchColumn(int)
-
setMatchColumn
void setMatchColumn(int[] columnIdxes) throws SQLException
Sets the designated columns as the match column for thisRowSet
object. AJoinRowSet
object can now add thisRowSet
object based on the match column.- Parameters:
columnIdxes
- an array ofint
identifying the indexes of the columns to be set as the match columns- Throws:
SQLException
- if an invalid column index is set- See Also:
setMatchColumn(int[])
,unsetMatchColumn(int[])
-
setMatchColumn
void setMatchColumn(String columnName) throws SQLException
Sets the designated column as the match column for thisRowSet
object. AJoinRowSet
object can now add thisRowSet
object based on the match column.Subinterfaces such as the
CachedRowSet
interface define the methodCachedRowSet.setKeyColumns
, which allows primary key semantics to be enforced on specific columns. Implementations of thesetMatchColumn(String columnIdx)
method should ensure that the constraints on the key columns are maintained when aCachedRowSet
object sets a primary key column as a match column.- Parameters:
columnName
- aString
object giving the name of the column to be set as the match column- Throws:
SQLException
- if an invalid column name is set, the column name is a null, or the column name is an empty string- See Also:
unsetMatchColumn(int)
,setMatchColumn(int[])
-
setMatchColumn
void setMatchColumn(String[] columnNames) throws SQLException
Sets the designated columns as the match column for thisRowSet
object. AJoinRowSet
object can now add thisRowSet
object based on the match column.- Parameters:
columnNames
- an array ofString
objects giving the names of the column to be set as the match columns- Throws:
SQLException
- if an invalid column name is set, the column name is a null, or the column name is an empty string- See Also:
unsetMatchColumn(int)
,setMatchColumn(int[])
-
getMatchColumnIndexes
int[] getMatchColumnIndexes() throws SQLException
Retrieves the indexes of the match columns that were set for thisRowSet
object with the methodsetMatchColumn(int[] columnIdxes)
.- Returns:
- an
int
array identifying the indexes of the columns that were set as the match columns for thisRowSet
object - Throws:
SQLException
- if no match column has been set- See Also:
setMatchColumn(int)
,unsetMatchColumn(int)
-
getMatchColumnNames
String[] getMatchColumnNames() throws SQLException
Retrieves the names of the match columns that were set for thisRowSet
object with the methodsetMatchColumn(String [] columnNames)
.- Returns:
- an array of
String
objects giving the names of the columns set as the match columns for thisRowSet
object - Throws:
SQLException
- if no match column has been set- See Also:
setMatchColumn(int)
,unsetMatchColumn(int)
-
unsetMatchColumn
void unsetMatchColumn(int columnIdx) throws SQLException
Unsets the designated column as the match column for thisRowSet
object.RowSet
objects that implement theJoinable
interface must ensure that a key-like constraint continues to be enforced until the methodCachedRowSet.unsetKeyColumns
has been called on the designated column.- Parameters:
columnIdx
- anint
that identifies the index of the column that is to be unset as a match column- Throws:
SQLException
- if an invalid column index is designated or if the designated column was not previously set as a match column- See Also:
setMatchColumn(int)
-
unsetMatchColumn
void unsetMatchColumn(int[] columnIdxes) throws SQLException
Unsets the designated columns as the match column for thisRowSet
object.- Parameters:
columnIdxes
- an arrary ofint
that identifies the indexes of the columns that are to be unset as match columns- Throws:
SQLException
- if an invalid column index is designated or if the designated column was not previously set as a match column- See Also:
setMatchColumn(int)
-
unsetMatchColumn
void unsetMatchColumn(String columnName) throws SQLException
Unsets the designated column as the match column for thisRowSet
object.RowSet
objects that implement theJoinable
interface must ensure that a key-like constraint continues to be enforced until the methodCachedRowSet.unsetKeyColumns
has been called on the designated column.- Parameters:
columnName
- aString
object giving the name of the column that is to be unset as a match column- Throws:
SQLException
- if an invalid column name is designated or the designated column was not previously set as a match column- See Also:
setMatchColumn(int)
-
unsetMatchColumn
void unsetMatchColumn(String[] columnName) throws SQLException
Unsets the designated columns as the match columns for thisRowSet
object.- Parameters:
columnName
- an array ofString
objects giving the names of the columns that are to be unset as the match columns- Throws:
SQLException
- if an invalid column name is designated or the designated column was not previously set as a match column- See Also:
setMatchColumn(int)
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/sql/rowset/joinable.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.