Package cdc.util.data.util

Interface AttributeNameConverter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface AttributeNameConverter

Interface used to convert (replace) an attribute name.

Author:

Damien Carbonne

Field Summary

Fields

Modifier and Type	Field	Description
static AttributeNameConverter	IDENTITY	An attribute name converter that returns the name unchanged.

Method Summary

Modifier and Type	Method	Description
default AttributeNameConverter	andThen(AttributeNameConverter other)	Returns a converter that first applies this converter and then other.
default AttributeNameConverter	compose(AttributeNameConverter other)	Returns a converter that first applies other then this converter.
java.lang.String	convertAttributeName(Element element, java.lang.String name)	Returns the name that should be used instead of the original name.
static AttributeNameConverter	fromNameFunction(java.util.function.Function<java.lang.String,java.lang.String> function)	Creates a new AttributeNameConverter from a name converter function.
static AttributeNameConverter	fromNameMap(java.util.Map<java.lang.String,java.lang.String> map)	Creates a new AttributeNameConverter from a map.
static AttributeNameConverter	fromPathMap(java.util.Map<SPath,java.lang.String> map)

Field Detail

IDENTITY

static final AttributeNameConverter IDENTITY

An attribute name converter that returns the name unchanged.

Method Detail

convertAttributeName

java.lang.String convertAttributeName(Element element,
                                      java.lang.String name)

Returns the name that should be used instead of the original name.

Parameters:

element - The element.

name - The attribute name.

Returns:

The name to use for attribute, instead of name.

compose

default AttributeNameConverter compose(AttributeNameConverter other)

Returns a converter that first applies other then this converter.

Parameters:

other - The other converter.

Returns:

A converter that first applies other then this converter.

Throws:

java.lang.IllegalArgumentException - When other is null.

andThen

default AttributeNameConverter andThen(AttributeNameConverter other)

Returns a converter that first applies this converter and then other.

Parameters:

other - The other converter.

Returns:

A converter that first applies this converter and then other.

Throws:

java.lang.IllegalArgumentException - When other is null.

fromNameFunction

static AttributeNameConverter fromNameFunction(java.util.function.Function<java.lang.String,java.lang.String> function)

Creates a new AttributeNameConverter from a name converter function.

Conversion is independent of element.

Parameters:

function - The function used to convert attribute names.

Returns:

A new AttributeValueConverter from function.

Throws:

java.lang.IllegalArgumentException - When function is null.

fromNameMap

static AttributeNameConverter fromNameMap(java.util.Map<java.lang.String,java.lang.String> map)

Creates a new AttributeNameConverter from a map.

Conversion is independent of element.
If a name is not mapped, then result is that name.

Parameters:

map - The map.

Returns:

A new AttributeValueConverter from map.

Throws:

java.lang.IllegalArgumentException - When map is null.

fromPathMap

static AttributeNameConverter fromPathMap(java.util.Map<SPath,java.lang.String> map)