com.ibm.etools.xsd
Interface XSDDiagnostic

All Superinterfaces:
com.ibm.etools.emf.notify.Notifier, com.ibm.etools.emf.ref.RefBaseObject, com.ibm.etools.emf.ref.RefObject, com.ibm.etools.emf.resource.ResourceSetReference
All Known Implementing Classes:
XSDDiagnosticImpl

public interface XSDDiagnostic
extends com.ibm.etools.emf.ref.RefObject

A representation of the model object 'Diagnostic'.

The following features are supported:

See Also:
XSDPackage.getXSDDiagnostic()

Field Summary
static java.lang.String copyright
           
static java.lang.String MARKER
          This is the ID used for Eclipse markers that are based on diagnostics.
static java.lang.String URI_REFERENCE_PATH_ATTRIBUTE
          This is the string for encoding a reference path for a diagnostic.
 
Fields inherited from interface com.ibm.etools.emf.notify.Notifier
ADD, ADD_MANY, CREATE, MOVE, NO_INDEX, REMOVE, REMOVE_MANY, REMOVING_ADAPTER, SET, TOUCH, UNSET
 
Method Summary
 com.ibm.etools.emf.ecore.EClass eClassXSDDiagnostic()
          Returns the meta class of XSDDiagnostic.
 XSDPackage ePackageXSD()
          Returns the meta package of XSDDiagnostic.
 java.lang.String getAnnotationURI()
          Returns the value of the 'Annotation URI' attribute.
 java.lang.Integer getColumn()
          Returns the value of the 'Column' attribute.
 com.ibm.etools.emf.ref.EList getComponents()
          Returns the value of the 'Components' reference list.
 java.lang.Integer getLine()
          Returns the value of the 'Line' attribute.
 com.ibm.etools.emf.ecore.EEnumLiteral getLiteralSeverity()
          Returns the value of the 'Severity' attribute.
 java.lang.String getLocationURI()
          Returns the value of the 'Location URI' attribute.
 java.lang.String getMessage()
          Returns the value of the 'Message' attribute.
 Node getNode()
          Returns the value of the 'Node' attribute.
 XSDConcreteComponent getPrimaryComponent()
          Returns the value of the 'Primary Component' reference.
 java.lang.Integer getSeverity()
          Returns the Integer value of the 'Severity' attribute.
 java.lang.String getStringSeverity()
          Returns the String value of the 'Severity' attribute.
 java.lang.String getURIReferencePath()
          Returns the value of the 'URI Reference Path' attribute.
 int getValueColumn()
          Returns the primitive value of the 'Column' attribute.
 int getValueLine()
          Returns the primitive value of the 'Line' attribute.
 int getValueSeverity()
          Returns the primitive value of the 'Severity' attribute.
 boolean isSetAnnotationURI()
          Returns whether the value of the 'Annotation URI' attribute is set.
 boolean isSetColumn()
          Returns whether the value of the 'Column' attribute is set.
 boolean isSetLine()
          Returns whether the value of the 'Line' attribute is set.
 boolean isSetLocationURI()
          Returns whether the value of the 'Location URI' attribute is set.
 boolean isSetMessage()
          Returns whether the value of the 'Message' attribute is set.
 boolean isSetNode()
          Returns whether the value of the 'Node' attribute is set.
 boolean isSetPrimaryComponent()
          Returns whether the value of the 'Primary Component' reference is set.
 boolean isSetSeverity()
          Returns whether the value of the 'Severity' attribute is set.
 void setAnnotationURI(java.lang.String value)
          Sets the value of the 'Annotation URI' attribute.
 void setColumn(int value)
          Sets the value of the 'Column' attribute.
 void setColumn(java.lang.Integer value)
          Sets the value of the 'Column' attribute.
 void setLine(int value)
          Sets the value of the 'Line' attribute.
 void setLine(java.lang.Integer value)
          Sets the value of the 'Line' attribute.
 void setLocationURI(java.lang.String value)
          Sets the value of the 'Location URI' attribute.
 void setMessage(java.lang.String value)
          Sets the value of the 'Message' attribute.
 void setNode(Node value)
          Sets the value of the 'Node' attribute.
 void setPrimaryComponent(XSDConcreteComponent value)
          Sets the value of the 'Primary Component' reference.
 void setSeverity(com.ibm.etools.emf.ecore.EEnumLiteral value)
          Sets the value of the 'Severity' attribute.
 void setSeverity(int value)
          Sets the value of the 'Severity' attribute.
 void setSeverity(java.lang.Integer value)
          Sets the value of the 'Severity' attribute.
 void setSeverity(java.lang.String value)
          Sets the value of the 'Severity' attribute.
 void unsetAnnotationURI()
          Unsets the value of the 'Annotation URI' attribute.
 void unsetColumn()
          Unsets the value of the 'Column' attribute.
 void unsetLine()
          Unsets the value of the 'Line' attribute.
 void unsetLocationURI()
          Unsets the value of the 'Location URI' attribute.
 void unsetMessage()
          Unsets the value of the 'Message' attribute.
 void unsetNode()
          Unsets the value of the 'Node' attribute.
 void unsetPrimaryComponent()
          Unsets the value of the 'Primary Component' reference.
 void unsetSeverity()
          Unsets the value of the 'Severity' attribute.
 
Methods inherited from interface com.ibm.etools.emf.ref.RefObject
initInstance, refAddValue, refAddValueAt, refAddValueBefore, refCurrentValues, refDelegateOwner, refGetDefaultValues, refIsSet, refModifyValue, refModifyValueAt, refRemoveValue, refRemoveValueAt, refSetDelegateOwner, refSetValue, refUnsetValue, refValue
 
Methods inherited from interface com.ibm.etools.emf.ref.RefBaseObject
metaObject, refAttributes, refContainer, refContainerExtent, refContainerSF, refContainments, refContainments, refContains, refContains, refContainsExtent, refContainsNested, refDelete, refExtent, refID, refImmediatePackage, refIsContainer, refItself, refMetaObject, refMofId, refName, refOutermostPackage, refPackage, refReferences, refRemoveContent, refResource, refSetExtent, refSetID, refSetID, refSetIDContains, refSetMetaObject, refSetUUID, refSetUUID, refSetUUID
 
Methods inherited from interface com.ibm.etools.emf.notify.Notifier
addAdapter, getAdapter, getAdapters, getExistingAdapter, isDelivery, isDeliveryAll, notify, notify, removeAdapter, removeAllAdapters, setDelivery, setDeliveryAll
 
Methods inherited from interface com.ibm.etools.emf.resource.ResourceSetReference
getResourceSet
 

Field Detail

copyright

public static final java.lang.String copyright

MARKER

public static final java.lang.String MARKER
This is the ID used for Eclipse markers that are based on diagnostics.

URI_REFERENCE_PATH_ATTRIBUTE

public static final java.lang.String URI_REFERENCE_PATH_ATTRIBUTE
This is the string for encoding a reference path for a diagnostic.
See Also:
getURIReferencePath()
Method Detail

ePackageXSD

public XSDPackage ePackageXSD()
Returns the meta package of XSDDiagnostic.
Returns:
the meta package of XSDDiagnostic.

eClassXSDDiagnostic

public com.ibm.etools.emf.ecore.EClass eClassXSDDiagnostic()
Returns the meta class of XSDDiagnostic.
Returns:
the meta class.
See Also:
XSDPackage.getXSDDiagnostic(), ePackageXSD()

getLiteralSeverity

public com.ibm.etools.emf.ecore.EEnumLiteral getLiteralSeverity()
Returns the value of the 'Severity' attribute. The literals are from the enumeration XSDDiagnosticSeverity. This indicates the how bad the problem is.
Returns:
the value of the 'Severity' attribute.
See Also:
getValueSeverity(), getSeverity(), getStringSeverity(), XSDDiagnosticSeverity, isSetSeverity(), unsetSeverity(), setSeverity(EEnumLiteral), XSDPackage.getXSDDiagnostic_Severity()

getValueSeverity

public int getValueSeverity()
Returns the primitive value of the 'Severity' attribute.
Returns:
the primitive value of the 'Severity' attribute.
See Also:
getLiteralSeverity(), getValueSeverity(), getStringSeverity(), XSDDiagnosticSeverity, isSetSeverity(), unsetSeverity(), setSeverity(int)

getStringSeverity

public java.lang.String getStringSeverity()
Returns the String value of the 'Severity' attribute.
Returns:
the String value of the 'Severity' attribute.
See Also:
getLiteralSeverity(), getSeverity(), getValueSeverity(), XSDDiagnosticSeverity, isSetSeverity(), unsetSeverity(), setSeverity(String)

getSeverity

public java.lang.Integer getSeverity()
Returns the Integer value of the 'Severity' attribute.
Returns:
the Integer value of the 'Severity' attribute.
See Also:
getLiteralSeverity(), getValueSeverity(), getStringSeverity(), XSDDiagnosticSeverity, isSetSeverity(), unsetSeverity(), setSeverity(Integer)

setSeverity

public void setSeverity(com.ibm.etools.emf.ecore.EEnumLiteral value)
                 throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Severity' attribute.
Parameters:
value - the new value of the 'Severity' attribute.
See Also:
setSeverity(int), setSeverity(Integer), setSeverity(String), XSDDiagnosticSeverity, isSetSeverity(), unsetSeverity(), getLiteralSeverity()

setSeverity

public void setSeverity(int value)
                 throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Severity' attribute.
Parameters:
value - the int value of the new enumeration literal value of the 'Severity' attribute.
See Also:
setSeverity(EEnumLiteral), setSeverity(Integer), setSeverity(String), XSDDiagnosticSeverity, isSetSeverity(), unsetSeverity(), getValueSeverity()

setSeverity

public void setSeverity(java.lang.String value)
                 throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Severity' attribute.
Parameters:
value - the String value of the new enumeration literal value of the 'Severity' attribute.
See Also:
setSeverity(EEnumLiteral), setSeverity(int), setSeverity(Integer), XSDDiagnosticSeverity, isSetSeverity(), unsetSeverity(), getStringSeverity()

setSeverity

public void setSeverity(java.lang.Integer value)
                 throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Severity' attribute.
Parameters:
value - the Integer value of the new enumeration literal value of the 'Severity' attribute.
See Also:
setSeverity(EEnumLiteral), setSeverity(int), setSeverity(String), XSDDiagnosticSeverity, isSetSeverity(), unsetSeverity(), getValueSeverity()

unsetSeverity

public void unsetSeverity()
Unsets the value of the 'Severity' attribute.
See Also:
isSetSeverity(), getLiteralSeverity(), setSeverity(EEnumLiteral)

isSetSeverity

public boolean isSetSeverity()
Returns whether the value of the 'Severity' attribute is set.
Returns:
whether the value of the 'Severity' attribute is set.
See Also:
unsetSeverity(), getLiteralSeverity(), setSeverity(EEnumLiteral)

getMessage

public java.lang.String getMessage()
Returns the value of the 'Message' attribute.

This describes the problem.

Returns:
the value of the 'Message' attribute.
See Also:
isSetMessage(), unsetMessage(), setMessage(String), XSDPackage.getXSDDiagnostic_Message()

setMessage

public void setMessage(java.lang.String value)
Sets the value of the 'Message' attribute.
Parameters:
value - the new value of the 'Message' attribute.
See Also:
isSetMessage(), unsetMessage(), getMessage()

unsetMessage

public void unsetMessage()
Unsets the value of the 'Message' attribute.
See Also:
isSetMessage(), getMessage(), setMessage(String)

isSetMessage

public boolean isSetMessage()
Returns whether the value of the 'Message' attribute is set.
Returns:
whether the value of the 'Message' attribute is set.
See Also:
unsetMessage(), getMessage(), setMessage(String)

getLocationURI

public java.lang.String getLocationURI()
Returns the value of the 'Location URI' attribute.

This indicates the URI of the resource containing the problem.

Returns:
the value of the 'Location URI' attribute.
See Also:
isSetLocationURI(), unsetLocationURI(), setLocationURI(String), XSDPackage.getXSDDiagnostic_LocationURI()

setLocationURI

public void setLocationURI(java.lang.String value)
Sets the value of the 'Location URI' attribute.
Parameters:
value - the new value of the 'Location URI' attribute.
See Also:
isSetLocationURI(), unsetLocationURI(), getLocationURI()

unsetLocationURI

public void unsetLocationURI()
Unsets the value of the 'Location URI' attribute.
See Also:
isSetLocationURI(), getLocationURI(), setLocationURI(String)

isSetLocationURI

public boolean isSetLocationURI()
Returns whether the value of the 'Location URI' attribute is set.
Returns:
whether the value of the 'Location URI' attribute is set.
See Also:
unsetLocationURI(), getLocationURI(), setLocationURI(String)

getLine

public java.lang.Integer getLine()
Returns the value of the 'Line' attribute.

This indicates the line number within the resource containing the problem.

Returns:
the value of the 'Line' attribute.
See Also:
getValueLine(), isSetLine(), unsetLine(), setLine(Integer), XSDPackage.getXSDDiagnostic_Line()

getValueLine

public int getValueLine()
Returns the primitive value of the 'Line' attribute.
Returns:
the primitive value of the 'Line' attribute.
See Also:
getLine(), isSetLine(), unsetLine(), setLine(int)

setLine

public void setLine(java.lang.Integer value)
Sets the value of the 'Line' attribute.
Parameters:
value - the new value of the 'Line' attribute.
See Also:
setLine(int), isSetLine(), unsetLine(), getLine()

setLine

public void setLine(int value)
Sets the value of the 'Line' attribute.
Parameters:
value - the new value of the 'Line' attribute.
See Also:
setLine(Integer), isSetLine(), unsetLine(), getValueLine()

unsetLine

public void unsetLine()
Unsets the value of the 'Line' attribute.
See Also:
isSetLine(), getLine(), setLine(Integer)

isSetLine

public boolean isSetLine()
Returns whether the value of the 'Line' attribute is set.
Returns:
whether the value of the 'Line' attribute is set.
See Also:
unsetLine(), getLine(), setLine(Integer)

getColumn

public java.lang.Integer getColumn()
Returns the value of the 'Column' attribute.

This indicates the column number within the line of the resource containing the problem.

Returns:
the value of the 'Column' attribute.
See Also:
getValueColumn(), isSetColumn(), unsetColumn(), setColumn(Integer), XSDPackage.getXSDDiagnostic_Column()

getValueColumn

public int getValueColumn()
Returns the primitive value of the 'Column' attribute.
Returns:
the primitive value of the 'Column' attribute.
See Also:
getColumn(), isSetColumn(), unsetColumn(), setColumn(int)

setColumn

public void setColumn(java.lang.Integer value)
Sets the value of the 'Column' attribute.
Parameters:
value - the new value of the 'Column' attribute.
See Also:
setColumn(int), isSetColumn(), unsetColumn(), getColumn()

setColumn

public void setColumn(int value)
Sets the value of the 'Column' attribute.
Parameters:
value - the new value of the 'Column' attribute.
See Also:
setColumn(Integer), isSetColumn(), unsetColumn(), getValueColumn()

unsetColumn

public void unsetColumn()
Unsets the value of the 'Column' attribute.
See Also:
isSetColumn(), getColumn(), setColumn(Integer)

isSetColumn

public boolean isSetColumn()
Returns whether the value of the 'Column' attribute is set.
Returns:
whether the value of the 'Column' attribute is set.
See Also:
unsetColumn(), getColumn(), setColumn(Integer)

getNode

public Node getNode()
Returns the value of the 'Node' attribute.

This indicates the DOM node at which the problem occurs.

Returns:
the value of the 'Node' attribute.
See Also:
isSetNode(), unsetNode(), setNode(org.w3c.dom.Node), XSDPackage.getXSDDiagnostic_Node()

setNode

public void setNode(Node value)
Sets the value of the 'Node' attribute.
Parameters:
value - the new value of the 'Node' attribute.
See Also:
isSetNode(), unsetNode(), getNode()

unsetNode

public void unsetNode()
Unsets the value of the 'Node' attribute.
See Also:
isSetNode(), getNode(), setNode(org.w3c.dom.Node)

isSetNode

public boolean isSetNode()
Returns whether the value of the 'Node' attribute is set.
Returns:
whether the value of the 'Node' attribute is set.
See Also:
unsetNode(), getNode(), setNode(org.w3c.dom.Node)

getAnnotationURI

public java.lang.String getAnnotationURI()
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.

Returns:
the value of the 'Annotation URI' attribute.
See Also:
isSetAnnotationURI(), unsetAnnotationURI(), setAnnotationURI(String), XSDPackage.getXSDDiagnostic_AnnotationURI()

setAnnotationURI

public void setAnnotationURI(java.lang.String value)
Sets the value of the 'Annotation URI' attribute.
Parameters:
value - the new value of the 'Annotation URI' attribute.
See Also:
isSetAnnotationURI(), unsetAnnotationURI(), getAnnotationURI()

unsetAnnotationURI

public void unsetAnnotationURI()
Unsets the value of the 'Annotation URI' attribute.
See Also:
isSetAnnotationURI(), getAnnotationURI(), setAnnotationURI(String)

isSetAnnotationURI

public boolean isSetAnnotationURI()
Returns whether the value of the 'Annotation URI' attribute is set.
Returns:
whether the value of the 'Annotation URI' attribute is set.
See Also:
unsetAnnotationURI(), getAnnotationURI(), setAnnotationURI(String)

getURIReferencePath

public java.lang.String getURIReferencePath()
Returns the value of the 'URI Reference Path' attribute.

This returns a path encoding that can be walked by XSDSchema.getDiagnosticForURIReferencePath(java.lang.String) to reach this diagnostic.

Returns:
the value of the 'URI Reference Path' attribute.
See Also:
XSDPackage.getXSDDiagnostic_URIReferencePath()

getComponents

public com.ibm.etools.emf.ref.EList getComponents()
Returns the value of the 'Components' reference list. The list contents are of type XSDConcreteComponent.

This represents the components associated with the problem; the first component is al the primary component.

Returns:
the value of the 'Components' reference list.
See Also:
XSDPackage.getXSDDiagnostic_Components()

getPrimaryComponent

public XSDConcreteComponent getPrimaryComponent()
Returns the value of the 'Primary Component' reference.

This represents the component most directly associated with the problem.

Returns:
the value of the 'Primary Component' reference.
See Also:
isSetPrimaryComponent(), unsetPrimaryComponent(), setPrimaryComponent(XSDConcreteComponent), XSDPackage.getXSDDiagnostic_PrimaryComponent()

setPrimaryComponent

public void setPrimaryComponent(XSDConcreteComponent value)
Sets the value of the 'Primary Component' reference.
Parameters:
value - the new value of the 'Primary Component' reference.
See Also:
isSetPrimaryComponent(), unsetPrimaryComponent(), getPrimaryComponent()

unsetPrimaryComponent

public void unsetPrimaryComponent()
Unsets the value of the 'Primary Component' reference.
See Also:
isSetPrimaryComponent(), getPrimaryComponent(), setPrimaryComponent(XSDConcreteComponent)

isSetPrimaryComponent

public boolean isSetPrimaryComponent()
Returns whether the value of the 'Primary Component' reference is set.
Returns:
whether the value of the 'Primary Component' reference is set.
See Also:
unsetPrimaryComponent(), getPrimaryComponent(), setPrimaryComponent(XSDConcreteComponent)