001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.math3.geometry.euclidean.threed;
019
020import java.text.FieldPosition;
021import java.text.NumberFormat;
022import java.text.ParsePosition;
023import java.util.Locale;
024
025import org.apache.commons.math3.exception.MathParseException;
026import org.apache.commons.math3.geometry.Vector;
027import org.apache.commons.math3.geometry.VectorFormat;
028import org.apache.commons.math3.util.CompositeFormat;
029
030/**
031 * Formats a 3D vector in components list format "{x; y; z}".
032 * <p>The prefix and suffix "{" and "}" and the separator "; " can be replaced by
033 * any user-defined strings. The number format for components can be configured.</p>
034 * <p>White space is ignored at parse time, even if it is in the prefix, suffix
035 * or separator specifications. So even if the default separator does include a space
036 * character that is used at format time, both input string "{1;1;1}" and
037 * " { 1 ; 1 ; 1 } " will be parsed without error and the same vector will be
038 * returned. In the second case, however, the parse position after parsing will be
039 * just after the closing curly brace, i.e. just before the trailing space.</p>
040 * <p><b>Note:</b> using "," as a separator may interfere with the grouping separator
041 * of the default {@link NumberFormat} for the current locale. Thus it is advised
042 * to use a {@link NumberFormat} instance with disabled grouping in such a case.</p>
043 *
044 * @version $Id: Vector3DFormat.java 1467801 2013-04-14 16:19:33Z tn $
045 */
046public class Vector3DFormat extends VectorFormat<Euclidean3D> {
047
048    /**
049     * Create an instance with default settings.
050     * <p>The instance uses the default prefix, suffix and separator:
051     * "{", "}", and "; " and the default number format for components.</p>
052     */
053    public Vector3DFormat() {
054        super(DEFAULT_PREFIX, DEFAULT_SUFFIX, DEFAULT_SEPARATOR,
055              CompositeFormat.getDefaultNumberFormat());
056    }
057
058    /**
059     * Create an instance with a custom number format for components.
060     * @param format the custom format for components.
061     */
062    public Vector3DFormat(final NumberFormat format) {
063        super(DEFAULT_PREFIX, DEFAULT_SUFFIX, DEFAULT_SEPARATOR, format);
064    }
065
066    /**
067     * Create an instance with custom prefix, suffix and separator.
068     * @param prefix prefix to use instead of the default "{"
069     * @param suffix suffix to use instead of the default "}"
070     * @param separator separator to use instead of the default "; "
071     */
072    public Vector3DFormat(final String prefix, final String suffix,
073                         final String separator) {
074        super(prefix, suffix, separator, CompositeFormat.getDefaultNumberFormat());
075    }
076
077    /**
078     * Create an instance with custom prefix, suffix, separator and format
079     * for components.
080     * @param prefix prefix to use instead of the default "{"
081     * @param suffix suffix to use instead of the default "}"
082     * @param separator separator to use instead of the default "; "
083     * @param format the custom format for components.
084     */
085    public Vector3DFormat(final String prefix, final String suffix,
086                         final String separator, final NumberFormat format) {
087        super(prefix, suffix, separator, format);
088    }
089
090    /**
091     * Returns the default 3D vector format for the current locale.
092     * @return the default 3D vector format.
093     */
094    public static Vector3DFormat getInstance() {
095        return getInstance(Locale.getDefault());
096    }
097
098    /**
099     * Returns the default 3D vector format for the given locale.
100     * @param locale the specific locale used by the format.
101     * @return the 3D vector format specific to the given locale.
102     */
103    public static Vector3DFormat getInstance(final Locale locale) {
104        return new Vector3DFormat(CompositeFormat.getDefaultNumberFormat(locale));
105    }
106
107    /**
108     * Formats a {@link Vector3D} object to produce a string.
109     * @param vector the object to format.
110     * @param toAppendTo where the text is to be appended
111     * @param pos On input: an alignment field, if desired. On output: the
112     *            offsets of the alignment field
113     * @return the value passed in as toAppendTo.
114     */
115    @Override
116    public StringBuffer format(final Vector<Euclidean3D> vector, final StringBuffer toAppendTo,
117                               final FieldPosition pos) {
118        final Vector3D v3 = (Vector3D) vector;
119        return format(toAppendTo, pos, v3.getX(), v3.getY(), v3.getZ());
120    }
121
122    /**
123     * Parses a string to produce a {@link Vector3D} object.
124     * @param source the string to parse
125     * @return the parsed {@link Vector3D} object.
126     * @throws MathParseException if the beginning of the specified string
127     * cannot be parsed.
128     */
129    @Override
130    public Vector3D parse(final String source) throws MathParseException {
131        ParsePosition parsePosition = new ParsePosition(0);
132        Vector3D result = parse(source, parsePosition);
133        if (parsePosition.getIndex() == 0) {
134            throw new MathParseException(source,
135                                         parsePosition.getErrorIndex(),
136                                         Vector3D.class);
137        }
138        return result;
139    }
140
141    /**
142     * Parses a string to produce a {@link Vector3D} object.
143     * @param source the string to parse
144     * @param pos input/ouput parsing parameter.
145     * @return the parsed {@link Vector3D} object.
146     */
147    @Override
148    public Vector3D parse(final String source, final ParsePosition pos) {
149        final double[] coordinates = parseCoordinates(3, source, pos);
150        if (coordinates == null) {
151            return null;
152        }
153        return new Vector3D(coordinates[0], coordinates[1], coordinates[2]);
154    }
155
156}