KKey (AQDEF tools 1.0.1 API)

java.lang.Object
- cz.diribet.aqdef.KKey

All Implemented Interfaces:

Serializable, Comparable<KKey>
```
public final class KKey
extends Object
implements Serializable, Comparable<KKey>
```
K-key (also referred to as 'Key field' / 'K field' in the documentation of AQDEF format)
Represents single key in AQDEF format (e.g. K1001) and can be used to create AQDEF data structure (K-key : value pairs).

You can obtain KKey instance by calling of(String).
K-key instances are thread safe, immutable and cached. If you call of(String) for the same K-key multiple times, you will probably get the same instances of KKey (this behavior is not guaranteed).

K-key also provides some metadata like datatype of the K-key. These can be retrieved like this:
```
  KKey kKey = KKey.of("K1001");
  KKeyMetadata metadata = kKey.getMetadata();
 
```
Or you can directly read metadata properties using delegate methods getDataType(), getConverter() etc.
Author:

Vlastimil Dolejs

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class KKey.Level

Nested Classes
Modifier and Type	Class and Description
`static class`	`KKey.Level`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(KKey o)`
`boolean`	`equals(Object obj)`
`IKKeyValueConverter<?>`	`getConverter()` See `KKeyMetadata.getConverter()`
`Class<?>`	`getDataType()` See `KKeyMetadata.getDataType()`
`String`	`getDbColumnName()` See `KKeyMetadata.getColumnName()`
`String`	`getKey()`
`KKey.Level`	`getLevel()` Returns `KKey.Level` of the AQDEF structure this K-key belongs to.
`KKeyMetadata`	`getMetadata()` Gets `metadata` of this K-key
`int`	`hashCode()`
`boolean`	`isCharacteristicLevel()`
`boolean`	`isCustom()`
`boolean`	`isGroupLevel()`
`boolean`	`isHierarchyLevel()`
`boolean`	`isPartLevel()`
`boolean`	`isSimpleHierarchyLevel()`
`boolean`	`isValueLevel()`
`static KKey`	`of(String key)` Gets the instance of `KKey` for the given `key`.
`boolean`	`shouldBeWrittenToDfq()`
`String`	`toString()`

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

- Method Detail
  - of
```
public static KKey of(String key)
```
    Gets the instance of KKey for the given key. Returned instance may not be a new instance, but reused instance from cache.
    
    Parameters:
    
    key -
    
    Returns:
  - getKey
```
public String getKey()
```
  - getConverter
```
public IKKeyValueConverter<?> getConverter()
```
    See KKeyMetadata.getConverter()
    
    Returns:
  - getDbColumnName
```
public String getDbColumnName()
```
    See KKeyMetadata.getColumnName()
    
    Returns:
  - getDataType
```
public Class<?> getDataType()
```
    See KKeyMetadata.getDataType()
    
    Returns:
  - getMetadata
```
public KKeyMetadata getMetadata()
```
    Gets metadata of this K-key
    
    Returns:
  - getLevel
```
public KKey.Level getLevel()
```
    Returns KKey.Level of the AQDEF structure this K-key belongs to.
    
    Returns:
  - isPartLevel
```
public boolean isPartLevel()
```
    Returns:
    
    whether this key represents information for part (dil / teil)
  - isCharacteristicLevel
```
public boolean isCharacteristicLevel()
```
    Returns:
    
    whether this key represents information for characterstic (znak / merkmal)
  - isValueLevel
```
public boolean isValueLevel()
```
    Returns:
    
    whether this key represents information for value (hodnota / wertevar)
  - isGroupLevel
```
public boolean isGroupLevel()
```
    Returns:
    
    whether this key represents information about logical group
  - isHierarchyLevel
```
public boolean isHierarchyLevel()
```
    Returns:
    
    whether this key represents information about hierarchy
  - isSimpleHierarchyLevel
```
public boolean isSimpleHierarchyLevel()
```
    Returns:
    
    whether this key represents information about simple hierarchy
  - isCustom
```
public boolean isCustom()
```
    Returns:
    
    whether this key represents our custom key
  - shouldBeWrittenToDfq
```
public boolean shouldBeWrittenToDfq()
```
    Returns:
    
    whether this k-key should be written to DFQ file
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(KKey o)
```
    Specified by:
    
    compareTo in interface Comparable<KKey>

Class KKey

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

getKey

getConverter

getDbColumnName

getDataType

getMetadata

getLevel

isPartLevel

isCharacteristicLevel

isValueLevel

isGroupLevel

isHierarchyLevel

isSimpleHierarchyLevel

isCustom

shouldBeWrittenToDfq

hashCode

equals

toString

compareTo