org.eclipse.xsd.XSDDiagnostic Maven / Gradle / Ivy
/**
* Copyright (c) 2002-2006 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v2.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v20.html
*
* Contributors:
* IBM - Initial API and implementation
*/
package org.eclipse.xsd;
import org.w3c.dom.Node;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.resource.Resource;
/**
*
* A representation of the model object 'Diagnostic'.
* @extends Resource.Diagnostic
*
*
*
* The following features are supported:
*
*
* - {@link org.eclipse.xsd.XSDDiagnostic#getSeverity Severity}
* - {@link org.eclipse.xsd.XSDDiagnostic#getMessage Message}
* - {@link org.eclipse.xsd.XSDDiagnostic#getLocationURI Location URI}
* - {@link org.eclipse.xsd.XSDDiagnostic#getLine Line}
* - {@link org.eclipse.xsd.XSDDiagnostic#getColumn Column}
* - {@link org.eclipse.xsd.XSDDiagnostic#getNode Node}
* - {@link org.eclipse.xsd.XSDDiagnostic#getAnnotationURI Annotation URI}
* - {@link org.eclipse.xsd.XSDDiagnostic#getKey Key}
* - {@link org.eclipse.xsd.XSDDiagnostic#getSubstitutions Substitutions}
* - {@link org.eclipse.xsd.XSDDiagnostic#getComponents Components}
* - {@link org.eclipse.xsd.XSDDiagnostic#getPrimaryComponent Primary Component}
*
*
* @see org.eclipse.xsd.XSDPackage#getXSDDiagnostic()
* @model
* @generated
*/
public interface XSDDiagnostic extends XSDConcreteComponent, Resource.Diagnostic
{
/**
* This is the ID used for Eclipse markers that are based on diagnostics.
*/
public static final String MARKER = "org.eclipse.xsd.diagnostic";
/**
* This is the string for encoding a {@link Resource#getURIFragment URI fragment} for a diagnostic.
* @see Resource#getURIFragment
*/
public static final String URI_FRAGMENT_ATTRIBUTE = "diagnostic";
/**
* Returns the value of the 'Severity' attribute.
* The literals are from the enumeration {@link org.eclipse.xsd.XSDDiagnosticSeverity}.
*
* This indicates the how bad the problem is.
*
* @return the value of the 'Severity' attribute.
* @see org.eclipse.xsd.XSDDiagnosticSeverity
* @see #setSeverity(XSDDiagnosticSeverity)
* @see org.eclipse.xsd.XSDPackage#getXSDDiagnostic_Severity()
* @model
* @generated
*/
XSDDiagnosticSeverity getSeverity();
/**
* Sets the value of the '{@link org.eclipse.xsd.XSDDiagnostic#getSeverity Severity}' attribute.
*
*
* @param value the new value of the 'Severity' attribute.
* @see org.eclipse.xsd.XSDDiagnosticSeverity
* @see #getSeverity()
* @generated
*/
void setSeverity(XSDDiagnosticSeverity value);
/**
* Returns the value of the 'Message' attribute.
*
*
* This describes the problem.
*
*
* @return the value of the 'Message' attribute.
* @see #setMessage(String)
* @see org.eclipse.xsd.XSDPackage#getXSDDiagnostic_Message()
* @model
* @generated
*/
String getMessage();
/**
* Sets the value of the '{@link org.eclipse.xsd.XSDDiagnostic#getMessage Message}' attribute.
*
*
* @param value the new value of the 'Message' attribute.
* @see #getMessage()
* @generated
*/
void setMessage(String value);
/**
* Returns the value of the 'Location URI' attribute.
*
*
* This indicates the URI of the resource containing the problem.
*
*
* @return the value of the 'Location URI' attribute.
* @see #setLocationURI(String)
* @see org.eclipse.xsd.XSDPackage#getXSDDiagnostic_LocationURI()
* @model
* @generated
*/
String getLocationURI();
/**
* Sets the value of the '{@link org.eclipse.xsd.XSDDiagnostic#getLocationURI Location URI}' attribute.
*
*
* @param value the new value of the 'Location URI' attribute.
* @see #getLocationURI()
* @generated
*/
void setLocationURI(String value);
/**
* Returns the value of the 'Line' attribute.
* The default value is "1".
*
*
* This indicates the line number within the resource containing the problem.
*
*
* @return the value of the 'Line' attribute.
* @see #setLine(int)
* @see org.eclipse.xsd.XSDPackage#getXSDDiagnostic_Line()
* @model default="1"
* @generated
*/
int getLine();
/**
* Sets the value of the '{@link org.eclipse.xsd.XSDDiagnostic#getLine Line}' attribute.
*
*
* @param value the new value of the 'Line' attribute.
* @see #getLine()
* @generated
*/
void setLine(int value);
/**
* Returns the value of the 'Column' attribute.
* The default value is "1".
*
*
* This indicates the column number within the line of the resource containing the problem.
*
*
* @return the value of the 'Column' attribute.
* @see #setColumn(int)
* @see org.eclipse.xsd.XSDPackage#getXSDDiagnostic_Column()
* @model default="1"
* @generated
*/
int getColumn();
/**
* Sets the value of the '{@link org.eclipse.xsd.XSDDiagnostic#getColumn Column}' attribute.
*
*
* @param value the new value of the 'Column' attribute.
* @see #getColumn()
* @generated
*/
void setColumn(int value);
/**
* Returns the value of the 'Node' attribute.
*
*
* This indicates the DOM node at which the problem occurs.
*
*
* @return the value of the 'Node' attribute.
* @see #setNode(Node)
* @see org.eclipse.xsd.XSDPackage#getXSDDiagnostic_Node()
* @model dataType="org.eclipse.xsd.DOMNode"
* @generated
*/
Node getNode();
/**
* Sets the value of the '{@link org.eclipse.xsd.XSDDiagnostic#getNode Node}' attribute.
*
*
* @param value the new value of the 'Node' attribute.
* @see #getNode()
* @generated
*/
void setNode(Node value);
/**
* Returns the value of the 'Annotation URI' attribute.
*
*
* This provides a URI that can be used to locate more detailed documentation of the general type of problem encountered.
*
*
* @return the value of the 'Annotation URI' attribute.
* @see #setAnnotationURI(String)
* @see org.eclipse.xsd.XSDPackage#getXSDDiagnostic_AnnotationURI()
* @model
* @generated
*/
String getAnnotationURI();
/**
* Sets the value of the '{@link org.eclipse.xsd.XSDDiagnostic#getAnnotationURI Annotation URI}' attribute.
*
*
* @param value the new value of the 'Annotation URI' attribute.
* @see #getAnnotationURI()
* @generated
*/
void setAnnotationURI(String value);
/**
* Returns the value of the 'Key' attribute.
*
*
* This represents a unique key used to load the message.
*
*
* @return the value of the 'Key' attribute.
* @see #setKey(String)
* @see org.eclipse.xsd.XSDPackage#getXSDDiagnostic_Key()
* @model
* @generated
*/
String getKey();
/**
* Sets the value of the '{@link org.eclipse.xsd.XSDDiagnostic#getKey Key}' attribute.
*
*
* @param value the new value of the 'Key' attribute.
* @see #getKey()
* @generated
*/
void setKey(String value);
/**
* Returns the value of the 'Substitutions' attribute list.
* The list contents are of type {@link java.lang.String}.
*
*
* This represents the substitutions within the message.
*
*
* @return the value of the 'Substitutions' attribute list.
* @see org.eclipse.xsd.XSDPackage#getXSDDiagnostic_Substitutions()
* @model
* @generated
*/
EList getSubstitutions();
/**
* Returns the value of the 'Components' reference list.
* The list contents are of type {@link org.eclipse.xsd.XSDConcreteComponent}.
*
*
* This represents the components associated with the problem;
* the first component is al the {@link #getPrimaryComponent() primary} component.
*
*
* @return the value of the 'Components' reference list.
* @see org.eclipse.xsd.XSDPackage#getXSDDiagnostic_Components()
* @model resolveProxies="false" required="true"
* @generated
*/
EList getComponents();
/**
* Returns the value of the 'Primary Component' reference.
*
*
* This represents the component most directly associated with the problem.
*
*
* @return the value of the 'Primary Component' reference.
* @see #setPrimaryComponent(XSDConcreteComponent)
* @see org.eclipse.xsd.XSDPackage#getXSDDiagnostic_PrimaryComponent()
* @model resolveProxies="false" required="true" transient="true" volatile="true"
* @generated
*/
XSDConcreteComponent getPrimaryComponent();
/**
* Sets the value of the '{@link org.eclipse.xsd.XSDDiagnostic#getPrimaryComponent Primary Component}' reference.
*
*
* @param value the new value of the 'Primary Component' reference.
* @see #getPrimaryComponent()
* @generated
*/
void setPrimaryComponent(XSDConcreteComponent value);
}