org.apache.xml.dtm.ref.NodeLocator Maven / Gradle / Ivy

/*
 * 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.
 */
/*
 * $Id: NodeLocator.java 468653 2006-10-28 07:07:05Z minchau $
 */

package org.apache.xml.dtm.ref;

import javax.xml.transform.SourceLocator;

/**
 * NodeLocator maintains information on an XML source
 * node.
 *
 * @author Ovidiu Predescu
 * @since May 23, 2001
 */
public class NodeLocator implements SourceLocator
{
  protected String m_publicId;
  protected String m_systemId;
  protected int m_lineNumber;
  protected int m_columnNumber;

  /**
   * Creates a new NodeLocator instance.
   *
   * @param publicId a String value
   * @param systemId a String value
   * @param lineNumber an int value
   * @param columnNumber an int value
   */
  public NodeLocator(String publicId, String systemId,
                     int lineNumber, int columnNumber)
  {
    this.m_publicId = publicId;
    this.m_systemId = systemId;
    this.m_lineNumber = lineNumber;
    this.m_columnNumber = columnNumber;
  }

  /**
   * getPublicId returns the public ID of the node.
   *
   * @return a String value
   */
  public String getPublicId()
  {
    return m_publicId;
  }

  /**
   * getSystemId returns the system ID of the node.
   *
   * @return a String value
   */
  public String getSystemId()
  {
    return m_systemId;
  }

  /**
   * getLineNumber returns the line number of the node.
   *
   * @return an int value
   */
  public int getLineNumber()
  {
    return m_lineNumber;
  }

  /**
   * getColumnNumber returns the column number of the
   * node.
   *
   * @return an int value
   */
  public int getColumnNumber()
  {
    return m_columnNumber;
  }

  /**
   * toString returns a string representation of this
   * NodeLocator instance.
   *
   * @return a String value
   */
  public String toString()
  {
    return "file '" + m_systemId
      + "', line #" + m_lineNumber
      + ", column #" + m_columnNumber;
  }
}