nl.renarj.jasdb.index.keys.keyinfo

Interface KeyNameMapper

All Superinterfaces:

Cloneable

All Known Implementing Classes:

KeyNameMapperImpl

public interface KeyNameMapper
extends Cloneable

Author:

Renze de Vries

Method Summary

Modifier and Type	Method and Description
Integer	addMappedField(String field)
KeyNameMapper	clone() Clones the key name mapper
String	getFieldForIndex(Integer index) Gets the field for the index
Set<String>	getFieldSet() Gets a set of fields mapper
int	getIndexForField(String field) Gets the index used for the given field
Map<Integer,String>	getMappings() Provides a Map containing the index to field mappings
int	getValueMarker()
boolean	isFullyMapped(Key key)
boolean	isMapped(String field) Check if a field is mapped
void	setValueMarker(int index)
int	size() The amount of mapped fields

Method Detail

getIndexForField

int getIndexForField(String field)

Gets the index used for the given field

Parameters:

field - The field to request the mapped index for

Returns:

The mapped index

getMappings

Map<Integer,String> getMappings()

Provides a Map containing the index to field mappings

Returns:

The index to field mappings

isMapped

boolean isMapped(String field)

Check if a field is mapped

Parameters:

field - The field to check if it is mapped

Returns:

True if the field is mapped, False if not

size

int size()

The amount of mapped fields

Returns:

THe amount of mapped fields

getFieldForIndex

String getFieldForIndex(Integer index)

Gets the field for the index

Parameters:

index - The index to get the field name for

Returns:

THe field name if present, null if not

getFieldSet

Set<String> getFieldSet()

Gets a set of fields mapper

Returns:

The set of mapped fields

clone

KeyNameMapper clone()

Clones the key name mapper

Returns:

The key name mapper

setValueMarker

void setValueMarker(int index)

getValueMarker

int getValueMarker()

addMappedField

Integer addMappedField(String field)

isFullyMapped

boolean isFullyMapped(Key key)