/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.math3.geometry.euclidean.oned;
import java.text.FieldPosition;
import java.text.NumberFormat;
import java.text.ParsePosition;
import java.util.Locale;
import org.apache.commons.math3.exception.MathParseException;
import org.apache.commons.math3.geometry.Vector;
import org.apache.commons.math3.geometry.VectorFormat;
import org.apache.commons.math3.util.CompositeFormat;
/**
* Formats a 1D vector in components list format "{x}".
* <p>The prefix and suffix "{" and "}" can be replaced by
* any user-defined strings. The number format for components can be configured.</p>
* <p>White space is ignored at parse time, even if it is in the prefix, suffix
* or separator specifications. So even if the default separator does include a space
* character that is used at format time, both input string "{1}" and
* " { 1 } " will be parsed without error and the same vector will be
* returned. In the second case, however, the parse position after parsing will be
* just after the closing curly brace, i.e. just before the trailing space.</p>
* <p><b>Note:</b> using "," as a separator may interfere with the grouping separator
* of the default {@link NumberFormat} for the current locale. Thus it is advised
* to use a {@link NumberFormat} instance with disabled grouping in such a case.</p>
*
* @since 3.0
*/
public class Vector1DFormat extends VectorFormat<Euclidean1D> {
/**
* Create an instance with default settings.
* <p>The instance uses the default prefix, suffix and separator:
* "{", "}", and "; " and the default number format for components.</p>
*/
public Vector1DFormat() {
super(DEFAULT_PREFIX, DEFAULT_SUFFIX, DEFAULT_SEPARATOR,
CompositeFormat.getDefaultNumberFormat());
}
/**
* Create an instance with a custom number format for components.
* @param format the custom format for components.
*/
public Vector1DFormat(final NumberFormat format) {
super(DEFAULT_PREFIX, DEFAULT_SUFFIX, DEFAULT_SEPARATOR, format);
}
/**
* Create an instance with custom prefix, suffix and separator.
* @param prefix prefix to use instead of the default "{"
* @param suffix suffix to use instead of the default "}"
*/
public Vector1DFormat(final String prefix, final String suffix) {
super(prefix, suffix, DEFAULT_SEPARATOR, CompositeFormat.getDefaultNumberFormat());
}
/**
* Create an instance with custom prefix, suffix, separator and format
* for components.
* @param prefix prefix to use instead of the default "{"
* @param suffix suffix to use instead of the default "}"
* @param format the custom format for components.
*/
public Vector1DFormat(final String prefix, final String suffix,
final NumberFormat format) {
super(prefix, suffix, DEFAULT_SEPARATOR, format);
}
/**
* Returns the default 1D vector format for the current locale.
* @return the default 1D vector format.
*/
public static Vector1DFormat getInstance() {
return getInstance(Locale.getDefault());
}
/**
* Returns the default 1D vector format for the given locale.
* @param locale the specific locale used by the format.
* @return the 1D vector format specific to the given locale.
*/
public static Vector1DFormat getInstance(final Locale locale) {
return new Vector1DFormat(CompositeFormat.getDefaultNumberFormat(locale));
}
/** {@inheritDoc} */
@Override
public StringBuffer format(final Vector<Euclidean1D> vector, final StringBuffer toAppendTo,
final FieldPosition pos) {
final Vector1D p1 = (Vector1D) vector;
return format(toAppendTo, pos, p1.getX());
}
/** {@inheritDoc} */
@Override
public Vector1D parse(final String source) throws MathParseException {
ParsePosition parsePosition = new ParsePosition(0);
Vector1D result = parse(source, parsePosition);
if (parsePosition.getIndex() == 0) {
throw new MathParseException(source,
parsePosition.getErrorIndex(),
Vector1D.class);
}
return result;
}
/** {@inheritDoc} */
@Override
public Vector1D parse(final String source, final ParsePosition pos) {
final double[] coordinates = parseCoordinates(1, source, pos);
if (coordinates == null) {
return null;
}
return new Vector1D(coordinates[0]);
}
}