Identifier (Cameleon OSP Specification)

java.lang.Object
- de.must.dataobj.Identifier

```
public class Identifier
extends java.lang.Object
```
Abstract identifier of table entries - no matter what their primary key is. The preferred way of accessing records is a unique key with one numeric field. Anyhow, to support older database designs, there may be a need to identify records via multiple key fields, maybe including different field types. To avoid switches in many components, all primary key cases are wrapped in this identifier class. Thus, only one type of object has to be passed.

See Also:

IdentifyTemplate, DataObject

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BEGIN_FIELD`
`static java.lang.String`	`ELEMENT_DELIMITER`
`static java.lang.String`	`END_FIELD`
`static int`	`REPRESENTATIVE_FOR_NOTHING`
`static Identifier`	`SIMPLE_IDENTIFIER_FOR_NEW_ENTRY`
`static Identifier`	`SIMPLE_IDENTIFIER_FOR_NOTHING`
`static java.lang.String`	`TYPE_DATE`
`static java.lang.String`	`TYPE_DOUBLE`
`static java.lang.String`	`TYPE_FLOAT`
`static java.lang.String`	`TYPE_INTEGER`
`static java.lang.String`	`TYPE_LONG`
`static java.lang.String`	`TYPE_STRING`

Constructor Summary

Constructors
Constructor and Description
`Identifier(int identifier)` Constructs a new identifier based upon a single integer primary key.
`Identifier(int identifier, java.lang.String tableContext)` Constructs a new identifier based upon a single integer primary key.
`Identifier(long identifier)`
`Identifier(java.lang.Object[] items)` Constructs a new identifier based on primary key based upon one or more items with optional different column types.
`Identifier(java.lang.Object[] items, java.lang.String tableContext)` Constructs a new identifier based on primary key based upon one or more items with optional different column types.
`Identifier(java.lang.String identifier)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Identifier identifierToCompare)`
`boolean`	`equals(java.lang.Object object)`
`java.sql.Date`	`getDateIdentifier()`
`java.sql.Date`	`getDateIdentifier(int index)`
`java.lang.String`	`getIdentifyCondition(IdentifyTemplate identifyTemplate, SqlDialect sqldialect)`
`int`	`getIntIdentifier()` Returns the integer value of the first item.
`int`	`getIntIdentifier(int index)` Returns the integer value of the item as specified by index.
`java.lang.Object[]`	`getItems()`
`long`	`getLongIdentifier()`
`java.lang.String`	`getStringIdentifier()`
`java.lang.String`	`getStringIdentifier(int index)`
`java.lang.String`	`getTableContext()`
`int`	`hashCode()`
`boolean`	`isRepresentativeForNewEntry()` Returns true if the identifier represents an entry to be build (inserted).
`boolean`	`isRepresentativeForNothing()` Returns true if the identifier represents "nothing" - no matter what type of columns it contains nor the number of the columns.
`static Identifier`	`parseString(java.lang.String idString)` Parses an identify string - made by toString - back to an identifier object.
`static Identifier`	`parseStringPrevious(java.lang.String identifyString)` Parses an identify string - made by toString - back to an identifier object.
`static java.util.Vector<Identifier>`	`parseToVector(java.lang.String identifyString)` Parses a string, which may represent multiple identifiers, to a vector.
`java.lang.String`	`toString()`
`java.lang.String`	`toStringPrevious()` Returns the identifier in a way it is expected by an SQL where clause - Strings are embedded in "'", numeric values aren't.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - BEGIN_FIELD
```
public static final java.lang.String BEGIN_FIELD
```
    See Also:
    
    Constant Field Values
  - END_FIELD
```
public static final java.lang.String END_FIELD
```
    See Also:
    
    Constant Field Values
  - TYPE_STRING
```
public static final java.lang.String TYPE_STRING
```
    See Also:
    
    Constant Field Values
  - TYPE_INTEGER
```
public static final java.lang.String TYPE_INTEGER
```
    See Also:
    
    Constant Field Values
  - TYPE_LONG
```
public static final java.lang.String TYPE_LONG
```
    See Also:
    
    Constant Field Values
  - TYPE_FLOAT
```
public static final java.lang.String TYPE_FLOAT
```
    See Also:
    
    Constant Field Values
  - TYPE_DOUBLE
```
public static final java.lang.String TYPE_DOUBLE
```
    See Also:
    
    Constant Field Values
  - TYPE_DATE
```
public static final java.lang.String TYPE_DATE
```
    See Also:
    
    Constant Field Values
  - ELEMENT_DELIMITER
```
public static final java.lang.String ELEMENT_DELIMITER
```
    See Also:
    
    Constant Field Values
  - REPRESENTATIVE_FOR_NOTHING
```
public static final int REPRESENTATIVE_FOR_NOTHING
```
    See Also:
    
    Constant Field Values
  - SIMPLE_IDENTIFIER_FOR_NOTHING
```
public static final Identifier SIMPLE_IDENTIFIER_FOR_NOTHING
```
  - SIMPLE_IDENTIFIER_FOR_NEW_ENTRY
```
public static final Identifier SIMPLE_IDENTIFIER_FOR_NEW_ENTRY
```
- Constructor Detail
  - Identifier
```
public Identifier(int identifier)
```
    Constructs a new identifier based upon a single integer primary key. Special identifiers are REPRESENTATIVE_FOR_NOTHING REPRESENTATIVE_FOR_NOTHING and REPRESENTATIVE_FOR_NEW_ENTRY.
    
    Parameters:
    
    identifier - the integer identify value
  - Identifier
```
public Identifier(int identifier,
                  java.lang.String tableContext)
```
    Constructs a new identifier based upon a single integer primary key. Constructs a new identifier based upon a single integer primary key. Special identifiers are REPRESENTATIVE_FOR_NOTHING REPRESENTATIVE_FOR_NOTHING and REPRESENTATIVE_FOR_NEW_ENTRY.
    
    Parameters:
    
    identifier - the integer identify value
    
    tableContext - the table context to avoid ambiguous assignment - in most cases not necessary
  - Identifier
```
public Identifier(long identifier)
```
  - Identifier
```
public Identifier(java.lang.String identifier)
```
  - Identifier
```
public Identifier(java.lang.Object[] items)
```
    Constructs a new identifier based on primary key based upon one or more items with optional different column types.
    
    Parameters:
    
    items - the value items of the primary key
  - Identifier
```
public Identifier(java.lang.Object[] items,
                  java.lang.String tableContext)
```
    Constructs a new identifier based on primary key based upon one or more items with optional different column types.
    
    Parameters:
    
    items - the value items of the primary key
    
    tableContext - the table context to avoid ambiguous assignment - in most cases not necessary
- Method Detail
  - parseToVector
```
public static java.util.Vector<Identifier> parseToVector(java.lang.String identifyString)
```
    Parses a string, which may represent multiple identifiers, to a vector.
    
    Parameters:
    
    identifyString - the string representing one or multiple identifiers
    
    Returns:
    
    the vector of identifiers
  - parseString
```
public static Identifier parseString(java.lang.String idString)
```
    Parses an identify string - made by toString - back to an identifier object.
    
    Parameters:
    
    identifyString - the string to parse
    
    Returns:
    
    the identify object
    
    See Also:
    
    IdentifyTemplate.parseString(String)
  - parseStringPrevious
```
public static Identifier parseStringPrevious(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
    
    See Also:
    
    IdentifyTemplate.parseString(String)
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toStringPrevious
```
public java.lang.String toStringPrevious()
```
    Returns the identifier in a way it is expected by an SQL where clause - Strings are embedded in "'", numeric values aren't.
    
    Returns:
    
    the identifier in a way it is expected by a SQL where clause
    
    See Also:
    
    IdentifyTemplate.toString(Identifier)
  - getItems
```
public java.lang.Object[] getItems()
```
  - getIntIdentifier
```
public int getIntIdentifier()
```
    Returns the integer value of the first item.
    
    Returns:
    
    the integer value of the first item
  - getIntIdentifier
```
public int getIntIdentifier(int index)
```
    Returns the integer value of the item as specified by index.
    
    Parameters:
    
    index - the index of the item value to be returned
    
    Returns:
    
    the integer value of the item as specified by index
  - getLongIdentifier
```
public long getLongIdentifier()
```
  - getStringIdentifier
```
public java.lang.String getStringIdentifier()
```
  - getStringIdentifier
```
public java.lang.String getStringIdentifier(int index)
```
  - getDateIdentifier
```
public java.sql.Date getDateIdentifier()
```
  - getDateIdentifier
```
public java.sql.Date getDateIdentifier(int index)
```
  - getTableContext
```
public java.lang.String getTableContext()
```
  - isRepresentativeForNewEntry
```
public boolean isRepresentativeForNewEntry()
```
    Returns true if the identifier represents an entry to be build (inserted).
    
    Returns:
    
    true if the identifier represents an entry to be build
  - isRepresentativeForNothing
```
public boolean isRepresentativeForNothing()
```
    Returns true if the identifier represents "nothing" - no matter what type of columns it contains nor the number of the columns.
    
    Returns:
    
    true if the identifier represents "nothing"
  - getIdentifyCondition
```
public java.lang.String getIdentifyCondition(IdentifyTemplate identifyTemplate,
                                             SqlDialect sqldialect)
```
  - equals
```
public boolean equals(java.lang.Object object)
```
    Overrides:
    
    equals in class java.lang.Object
  - equals
```
public boolean equals(Identifier identifierToCompare)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class Identifier

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BEGIN_FIELD

END_FIELD

TYPE_STRING

TYPE_INTEGER

TYPE_LONG

TYPE_FLOAT

TYPE_DOUBLE

TYPE_DATE

ELEMENT_DELIMITER

REPRESENTATIVE_FOR_NOTHING

SIMPLE_IDENTIFIER_FOR_NOTHING

SIMPLE_IDENTIFIER_FOR_NEW_ENTRY

Constructor Detail

Identifier

Identifier

Identifier

Identifier

Identifier

Identifier

Method Detail

parseToVector

parseString

parseStringPrevious

toString

toStringPrevious

getItems

getIntIdentifier

getIntIdentifier

getLongIdentifier

getStringIdentifier

getStringIdentifier

getDateIdentifier

getDateIdentifier

getTableContext

isRepresentativeForNewEntry

isRepresentativeForNothing

getIdentifyCondition

equals

equals

hashCode