org.odftoolkit.odfdom.type.CellAddress Maven / Gradle / Ivy

/**
 * **********************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *
 * 
Copyright 2008, 2010 Oracle and/or its affiliates. All rights reserved.
 *
 * 
Use is subject to license terms.
 *
 * 
Licensed 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. You can also obtain a copy of the License at
 * http://odftoolkit.org/docs/license.txt
 *
 * 
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.odftoolkit.odfdom.type;

import java.util.regex.Pattern;

/** This class represents the in OpenDocument format used data type {@odf.datatype cellAddress} */
public class CellAddress implements OdfDataType {

  private String mCellAddress;
  private static final Pattern cellAddressPattern =
      Pattern.compile("^(\\$?([^\\. ']+|'([^']|'')+'))?\\.\\$?[A-Z]+\\$?[0-9]+$");
  /**
   * Construct CellAddress by the parsing the given string
   *
   * @param cellAddress The String to be parsed into CellAddress
   * @throws IllegalArgumentException if the given argument is not a valid CellAddress
   */
  public CellAddress(String cellAddress) throws IllegalArgumentException {
    if (!isValid(cellAddress)) {
      throw new IllegalArgumentException("parameter is invalid for datatype CellAddress");
    }
    mCellAddress = cellAddress;
  }

  // TODO: Should a cell address stay a string?
  /**
   * Returns a String Object representing this CellAddress's value
   *
   * @return return a string representation of the value of this CellAddress object
   */
  @Override
  public String toString() {

    return mCellAddress;
  }

  /**
   * Returns a CellAddress instance representing the specified String value
   *
   * @param stringValue a String value
   * @return return a CellAddress instance representing stringValue
   * @throws IllegalArgumentException if the given argument is not a valid CellAddress
   */
  public static CellAddress valueOf(String stringValue) throws IllegalArgumentException {
    return new CellAddress(stringValue);
  }

  /**
   * check if the specified String is a valid {@odf.datatype cellAddress} data type
   *
   * @param stringValue the value to be tested
   * @return true if the value of argument is valid for {@odf.datatype cellAddress} data type false
   *     otherwise
   */
  public static boolean isValid(String stringValue) {
    if ((stringValue == null) || (!cellAddressPattern.matcher(stringValue).matches())) {
      return false;
    } else {
      return true;
    }
  }
}