de.must.dataobj

Class IdentifyTemplate

java.lang.Object

de.must.dataobj.IdentifyTemplate

public class IdentifyTemplate
extends java.lang.Object

A template how to identify a database entry.

See Also:

Identifier, DataObject

Field Summary

Fields

Modifier and Type	Field and Description
static int	IDENTIFIED_BY_INT
static int	IDENTIFIED_BY_LONG
static int	IDENTIFIED_BY_MULTIPLE_COLUMNS
static int	IDENTIFIED_BY_STRING
static int	IDENTIFIED_FREE_CONDITIONED
static int	TYPE_DATE
static int	TYPE_NUMERIC
static int	TYPE_TEXT

Constructor Summary

Constructors

Constructor and Description
IdentifyTemplate(Index index, AbstractAttribute[] attributes)
IdentifyTemplate(java.lang.String[] identifyColumnNames, int[] columnTypes) Constructs a identification template.

Method Summary

Modifier and Type	Method and Description
int[]	getColumnTypes()
java.lang.String[]	getIdentifyColumnNames()
java.lang.String	getIdentifyConditionForPreparedStatements() Returns the identify condition for prepared statements, e.g.
int	getIdentifyType()
Identifier	parseString(java.lang.String identifyString) Parses an identify string - made by toString - back to an identifier object.
void	setIdentifier(java.sql.PreparedStatement ps, Identifier ident, int[] lengths) Sets the identifying fields to get a unique row by using prepared statements.
void	setIdentifier(java.sql.PreparedStatement ps, Identifier ident, int[] lengths, int columnOffset) Sets the identifying fields to get a unique row by using prepared statements.
java.lang.String	toString(Identifier identifier) Builds a string representation of the specified identifier which may be parsed to an identifier again later via parseString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IDENTIFIED_BY_INT

public static final int IDENTIFIED_BY_INT

See Also:

Constant Field Values

IDENTIFIED_BY_LONG

public static final int IDENTIFIED_BY_LONG

See Also:

Constant Field Values

IDENTIFIED_BY_STRING

public static final int IDENTIFIED_BY_STRING

See Also:

Constant Field Values

IDENTIFIED_BY_MULTIPLE_COLUMNS

public static final int IDENTIFIED_BY_MULTIPLE_COLUMNS

See Also:

Constant Field Values

IDENTIFIED_FREE_CONDITIONED

public static final int IDENTIFIED_FREE_CONDITIONED

See Also:

Constant Field Values

TYPE_NUMERIC

public static final int TYPE_NUMERIC

See Also:

Constant Field Values

TYPE_TEXT

public static final int TYPE_TEXT

See Also:

Constant Field Values

TYPE_DATE

public static final int TYPE_DATE

See Also:

Constant Field Values

Constructor Detail

IdentifyTemplate

public IdentifyTemplate(Index index,
                        AbstractAttribute[] attributes)

IdentifyTemplate

public IdentifyTemplate(java.lang.String[] identifyColumnNames,
                        int[] columnTypes)

Constructs a identification template.

Parameters:

identifyColumnNames - the names of the columns to be used as primary key

columnTypes - the types of the columns to be used as primary key

Method Detail

getIdentifyType

public int getIdentifyType()

getIdentifyColumnNames

public java.lang.String[] getIdentifyColumnNames()

getColumnTypes

public int[] getColumnTypes()

toString

public java.lang.String toString(Identifier identifier)

Builds a string representation of the specified identifier which may be parsed to an identifier again later via parseString

Parameters:

identifier - the identifier to be transformed

Returns:

the string representation of the specified identifier

parseString

public Identifier parseString(java.lang.String identifyString)

Parses an identify string - made by toString - back to an identifier object.

Parameters:

identifyString - the string to parse

Returns:

the identify object

getIdentifyConditionForPreparedStatements

public java.lang.String getIdentifyConditionForPreparedStatements()

Returns the identify condition for prepared statements, e.g. where keyfield1 = ? and keyfield2 = ?

Returns:

the identify condition for prepared statements

setIdentifier

public void setIdentifier(java.sql.PreparedStatement ps,
                          Identifier ident,
                          int[] lengths)
                   throws java.sql.SQLException

Sets the identifying fields to get a unique row by using prepared statements. Use getIdentifyConditionForPreparedStatements to get the where condition part of the prepared statement query.

Parameters:

ps - the prepared statement to use

ident - the identifier to identify the wished row

lengths - the length of identifier fields to fill them with spaces if they are defined as char

Throws:

java.sql.SQLException

See Also:

getIdentifyConditionForPreparedStatements()

setIdentifier

public void setIdentifier(java.sql.PreparedStatement ps,
                          Identifier ident,
                          int[] lengths,
                          int columnOffset)
                   throws java.sql.SQLException

Sets the identifying fields to get a unique row by using prepared statements. Use getIdentifyConditionForPreparedStatements to get the where condition part of the prepared statement query.

Parameters:

ps - the prepared statement to use

ident - the identifier to identify the wished row

lengths - the length of identifier fields to fill them with spaces if they are defined as char

columnOffset - the offset of the key columns / the number of fields used in the prepared statements before the where condition fields

Throws:

java.sql.SQLException

See Also:

getIdentifyConditionForPreparedStatements()