/*
*
* 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.flex.compiler.fxg.dom;
import java.util.Collection;
import java.util.List;
import org.apache.flex.compiler.problems.ICompilerProblem;
/**
* Implementations of IFXGNode represent a node in the DOM of an FXG document.
*/
public interface IFXGNode
{
/**
* @return The XML element name of this node.
*/
String getNodeName();
/**
* @return The namespace URI of this node.
*/
String getNodeURI();
/**
* Adds an FXG child node to this node.
*
* @param child - a child FXG node to be added to this node.
* @param problems problem collection used to collect problems occurred within this method
*/
void addChild(IFXGNode child, Collection<ICompilerProblem> problems);
/**
* @return The root node of the FXG document.
*/
IFXGNode getDocumentNode();
/**
* Establishes the root node of the FXG document containing this node.
* @param root - the root node of the FXG document.
*/
void setDocumentNode(IFXGNode root);
/**
* @return - the path of the FXG file being processed.
*/
String getDocumentPath();
/**
* Sets an FXG attribute on this node.
*
* @param name - the unqualified attribute name
* @param value - the attribute value
* @param problems problem collection used to collect problems occurred within this method
*/
void setAttribute(String name, String value, Collection<ICompilerProblem> problems);
//--------------------------------------------------------------------------
//
// Document Line Information (Used in Error Reporting)
//
//--------------------------------------------------------------------------
/**
* @return the line on which the node declaration started.
*/
int getStartLine();
/**
* @param line - the line on which the node declaration started.
*/
void setStartLine(int line);
/**
* @return - the column on which the node declaration started.
*/
int getStartColumn();
/**
* @param column - the line on which the node declaration started.
*/
void setStartColumn(int column);
/**
* @return the line on which the node declaration ended.
*/
int getEndLine();
/**
* @param line - the line on which the node declaration ended.
*/
void setEndLine(int line);
/**
* @return - the column on which the node declaration ended.
*/
int getEndColumn();
/**
* @param column - the column on which the node declaration ended.
*/
void setEndColumn(int column);
/**
* debug method, do not use
* @return a list of the children of this node
*/
List<IFXGNode> getChildren();
}