uimaj-2.3.0-incubating/uimaj-ep-cas-editor/src/main/java/org/apache/uima/caseditor/core/model/INlpElement.java

/*
 * 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.uima.caseditor.core.model;

import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.CoreException;

/**
 * Interface for all nlp elements.
 */
public interface INlpElement {
  /**
   * Retrieves the name of the nlp element.
   * 
   * @return the name
   */
  String getName();

  /**
   * Retrieves the corresponding resource.
   * 
   * @return corresponding resource
   */
  IResource getResource();

  /**
   * Retrieves the parent element.
   * 
   * @return the parent element
   */
  INlpElement getParent();

  /**
   * Retrieves the INlpElement parent of a resource.
   * 
   * @param resource
   * @return the INlpElement parent or null if none
   * @throws CoreException
   */
  INlpElement getParent(IResource resource) throws CoreException;

  /**
   * Retrieves the nlp project.
   * 
   * @return the project
   */
  NlpProject getNlpProject();

  /**
   * Searches the corresponding nlp element for the given resource.
   * 
   * @param resource
   *          the resource to search
   * @return the nlp element or null if not found
   */
  INlpElement findMember(IResource resource);
}