Package org.apache.sis.measure

Class FormattedCharacterIterator

java.lang.Object

org.apache.sis.internal.util.SimpleCharacterIterator

org.apache.sis.measure.FormattedCharacterIterator

All Implemented Interfaces:

Serializable, CharSequence, Cloneable, AttributedCharacterIterator, CharacterIterator

final class FormattedCharacterIterator
extends SimpleCharacterIterator
implements AttributedCharacterIterator

The attributed character iterator to be returned by Format implementations in the org.apache.sis.measure package.

Implementation assumption

Every getRunStart(…) and getRunLimit(…) methods defined in this class check only for attribute existence, ignoring the actual attribute value. This is a departure from the AttributedCharacterIterator contract, but should be invisible to the users if there are no juxtaposed fields with the same attribute value (which is usually the case). A violation occurs if different fields are formatted without separator. For example if an angle is formatted as "DDMMSS" without any field separator, then we have 3 juxtaposed integer fields. If those fields have the same value, then the whole "DDMMSS" text should be seen as a single run according the AttributedCharacterIterator contract, while they will still been seen as 3 separated fields by this implementation.

Since:

0.3

Version:

0.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	FormattedCharacterIterator.Entry	Holds a field value, together with the run range in which this value is valid.
private static class	FormattedCharacterIterator.Filter	The object converter to use for filtering the keys in the map returned by getAttributes().
private static final class	FormattedCharacterIterator.Selector	The object converter to use for extracting FormattedCharacterIterator.Entry.value in the map returned by getAttributes().

Nested classes/interfaces inherited from interface java.text.AttributedCharacterIterator

AttributedCharacterIterator.Attribute

Field Summary

Fields

Modifier and Type	Field	Description
private Set<AttributedCharacterIterator.Attribute>	attributeKeys	An unmodifiable view over the keys of the attributes map.
private final Map<AttributedCharacterIterator.Attribute,FormattedCharacterIterator.Entry>	attributes	All fields associated to the text.
private int	limit	The value to be returned by getRunStart(…) and getRunLimit(…) when the index value is validity.
private AttributedCharacterIterator.Attribute	runAttribute	The attribute given in the last call to a getRunStart(…) or getRunLimit(…) method.
private static final long	serialVersionUID	For cross-version compatibility.
private int	start	The value to be returned by getRunStart(…) and getRunLimit(…) when the index value is validity.
private int	validity	The value to be returned by getRunStart(…) and getRunLimit(…) when the index value is validity.

Fields inherited from class org.apache.sis.internal.util.SimpleCharacterIterator

lower, text, upper

Fields inherited from interface java.text.CharacterIterator

DONE

Constructor Summary

Constructors

Constructor	Description
FormattedCharacterIterator(CharSequence text)	Creates a new character iterator for the given character sequence.

Method Summary

Modifier and Type	Method	Description
(package private) final void	addFieldLimit(AttributedCharacterIterator.Attribute field, Object value, int start)	Invoked by Format implementations when a field ended.
(package private) final void	append(AttributedCharacterIterator it, StringBuffer toAppendTo)	Appends all characters and attributes from the given iterator.
private Collection<FormattedCharacterIterator.Entry>	entries(Set<? extends AttributedCharacterIterator.Attribute> requested)	Returns the entries for the given attributes.
Set<AttributedCharacterIterator.Attribute>	getAllAttributeKeys()	Returns the keys of all attributes defined in the iterator text range.
Object	getAttribute(AttributedCharacterIterator.Attribute attribute)	Returns the value of the named attribute for the current character, or null if none.
Map<AttributedCharacterIterator.Attribute,Object>	getAttributes()	Returns the attributes defined on the current character.
int	getRunLimit()	Returns the index of the first character following the run having all the same attributes than the current character.
int	getRunLimit(AttributedCharacterIterator.Attribute attribute)	Returns the index of the first character following the run having the same "value" for the given attribute than the current character.
int	getRunLimit(Set<? extends AttributedCharacterIterator.Attribute> attributes)	Returns the index of the first character following the run having the same "values" for the given attributes than the current character.
int	getRunStart()	Returns the index of the first character of the run having all the same attributes than the current character.
int	getRunStart(AttributedCharacterIterator.Attribute attribute)	Returns the index of the first character of the run having the same "value" for the given attribute than the current character.
int	getRunStart(Set<? extends AttributedCharacterIterator.Attribute> attributes)	Returns the index of the first character of the run having the same "values" for the given attributes than the current character.
private void	update(AttributedCharacterIterator.Attribute attribute, Collection<FormattedCharacterIterator.Entry> entries)	Ensures that the start, limit and attributes fields are valid for the current index position and the given attribute.

Methods inherited from class org.apache.sis.internal.util.SimpleCharacterIterator

charAt, clone, current, first, getBeginIndex, getEndIndex, getIndex, last, length, next, previous, setIndex, subSequence, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.text.CharacterIterator

clone, current, first, getBeginIndex, getEndIndex, getIndex, last, next, previous, setIndex

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Field Details

serialVersionUID

private static final long serialVersionUID

For cross-version compatibility.

See Also:

• Constant Field Values

attributes

private final Map<AttributedCharacterIterator.Attribute,FormattedCharacterIterator.Entry> attributes

All fields associated to the text.

This map shall not be modified after this FormattedCharacterIterator become visible to the user. If this map could be modified, then we would need to override the SimpleCharacterIterator.clone() method in order to clone this map too.

attributeKeys

private transient Set<AttributedCharacterIterator.Attribute> attributeKeys

An unmodifiable view over the keys of the attributes map. This view is created when first needed.

See Also:

• getAllAttributeKeys()

runAttribute

private transient AttributedCharacterIterator.Attribute runAttribute

The attribute given in the last call to a getRunStart(…) or getRunLimit(…) method. Used for determining if the start and limit fields need a update. A null value means that the run range needs an unconditional update (this is the case after construction and after deserialization).

start

private transient int start

The value to be returned by getRunStart(…) and getRunLimit(…) when the index value is validity. Those values are updated when needed by the update(Attribute, Collection) method.

limit

private transient int limit

The value to be returned by getRunStart(…) and getRunLimit(…) when the index value is validity. Those values are updated when needed by the update(Attribute, Collection) method.

validity

private transient int validity

The value to be returned by getRunStart(…) and getRunLimit(…) when the index value is validity. Those values are updated when needed by the update(Attribute, Collection) method.

Constructor Details

FormattedCharacterIterator

FormattedCharacterIterator(CharSequence text)

Creates a new character iterator for the given character sequence.

Parameters:

text - the formatted text. Can be a StringBuilder to be filled later.

Method Details

addFieldLimit

final void addFieldLimit(AttributedCharacterIterator.Attribute field,
 Object value,
 int start)

Invoked by Format implementations when a field ended. This method stores the given attribute value for the run ranging from start inclusive to the current SimpleCharacterIterator.text length, exclusive.

append

final void append(AttributedCharacterIterator it,
 StringBuffer toAppendTo)

Appends all characters and attributes from the given iterator.

Parameters:

toAppendTo - shall be the same instance than SimpleCharacterIterator.text.

update

private void update(AttributedCharacterIterator.Attribute attribute,
 Collection<FormattedCharacterIterator.Entry> entries)

Ensures that the start, limit and attributes fields are valid for the current index position and the given attribute.

Parameters:

attribute - the attribute which shall have the same value in the run range.

entries - the entries on which to iterate for computing the run range. Mandatory if attribute is null.

getRunStart

public int getRunStart()

Returns the index of the first character of the run having all the same attributes than the current character. See this class javadoc for a note about which attributes are considered equal.

Specified by:

getRunStart in interface AttributedCharacterIterator

getRunStart

public int getRunStart(AttributedCharacterIterator.Attribute attribute)

Returns the index of the first character of the run having the same "value" for the given attribute than the current character. See this class javadoc for a note about which attribute "values" are considered equal.

Specified by:

getRunStart in interface AttributedCharacterIterator

getRunStart

public int getRunStart(Set<? extends AttributedCharacterIterator.Attribute> attributes)

Returns the index of the first character of the run having the same "values" for the given attributes than the current character. See this class javadoc for a note about which attribute "values" are considered equal.

Specified by:

getRunStart in interface AttributedCharacterIterator

getRunLimit

public int getRunLimit()

Returns the index of the first character following the run having all the same attributes than the current character. See this class javadoc for a note about which attributes are considered equal.

Specified by:

getRunLimit in interface AttributedCharacterIterator

getRunLimit

public int getRunLimit(AttributedCharacterIterator.Attribute attribute)

Returns the index of the first character following the run having the same "value" for the given attribute than the current character. See this class javadoc for a note about which attribute "values" are considered equal.

Specified by:

getRunLimit in interface AttributedCharacterIterator

getRunLimit

public int getRunLimit(Set<? extends AttributedCharacterIterator.Attribute> attributes)

Returns the index of the first character following the run having the same "values" for the given attributes than the current character. See this class javadoc for a note about which attribute "values" are considered equal.

Specified by:

getRunLimit in interface AttributedCharacterIterator

entries

private Collection<FormattedCharacterIterator.Entry> entries(Set<? extends AttributedCharacterIterator.Attribute> requested)

Returns the entries for the given attributes. This is a helper method for the getRunStart(Set) and getRunLimit(Set) methods.

getAttributes

public Map<AttributedCharacterIterator.Attribute,Object> getAttributes()

Returns the attributes defined on the current character.

Specified by:

getAttributes in interface AttributedCharacterIterator

getAttribute

public Object getAttribute(AttributedCharacterIterator.Attribute attribute)

Returns the value of the named attribute for the current character, or null if none.

Specified by:

getAttribute in interface AttributedCharacterIterator

getAllAttributeKeys

public Set<AttributedCharacterIterator.Attribute> getAllAttributeKeys()

Returns the keys of all attributes defined in the iterator text range.

Specified by:

getAllAttributeKeys in interface AttributedCharacterIterator