Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.bea.schema
Class SOMAnnotation

    java.lang.Object
      com.bea.schema.SOMObject
          com.bea.schema.SOMAnnotation

All Implemented Interfaces:
  Serializable

public class SOMAnnotation
extends SOMObject

<annotation> The XML representation for an annotation schema component is an element information item. Annotation of schemas and schema components, with material for human or computer consumption, is provided for by allowing application information and human information at the beginning of most major schema elements, and anywhere at the top level of schemas.

Version:
  1.0
Author:
  sharpe
See Also:
  Serialized Form

Constructor Summary
`SOMAnnotation()`

Method Summary
`SOMAppInfo` | `addAppInfo(SOMAppInfo appinfo)`
`SOMAppInfo` | `addAppInfo(String content)` The addAppInfo method is a utility method that creates a new SOMAppInfo object ( <appinfo> ) with an initial content string of content.
`SOMDocumentation` | `addDocumentation(SOMDocumentation documentation)` add a SOMDocumentation element to the schema tree
`SOMDocumentation` | `addDocumentation(String content)` The addDocumentation method is a utility method that creates a new SOMDocumentation object ( ) with an initial content string of content.
`SOMAppInfo` | `addInfo(SOMAppInfo info)` The addInfo method should be used to create child elements to the element.
`Iterator` | `getAppInfoElements()` returns an iterator for all AppInfo elements
`Iterator` | `getChildren()` returns an iterator for all child elements
`Iterator` | `getDocumentationElements()` returns an iterator for all documentation elements
`String` | `getID()` Returns a printable element tag for this Schema Object
`void` | `toXML(Writer rtn, int indent)` Outputs a formatted XML representation of SOMObject.

Methods inherited from class com.bea.schema.SOMObject
`addPrefixMapping, getContainmentXPath, getEffectivePrefixMappings, getID_UQ, getParent, getParentName, getParentSchema, getPrefixForTargetNamespace, getPrefixMapping, getTargetNamespace, getURIForPrefix, isCircularReference, isSchemaChild, msg, msg, removeNamespaceQualifier, removePrefixMapping, setIndent, setParent, setTargetNamespace, toString, toXML, toXML, toXML`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### SOMAnnotation

    public SOMAnnotation()

Method Detail

### getID

    public String getID()

  Description copied from class: `SOMObject`
  Returns a printable element tag for this Schema Object

  Specified by:
    `getID` in class `SOMObject`
  Returns:
    String representation of the element tag

### addDocumentation

    public SOMDocumentation addDocumentation(String content)

  The addDocumentation method is a utility method that creates a new SOMDocumentation object ( ) with an initial content string of content. The newly created object is added as a sub-element of the annotation and returned.

  Parameters:
    `content` - The content body for the documentation element.
  Returns:
    a reference to the newly created object

### addDocumentation

    public SOMDocumentation addDocumentation(SOMDocumentation documentation)

  add a SOMDocumentation element to the schema tree

  Parameters:
    `documentation` - the documentation element to be added
  Returns:
    a reference to the added <documentation> object

### addAppInfo

    public SOMAppInfo addAppInfo(String content)

  The addAppInfo method is a utility method that creates a new SOMAppInfo object ( <appinfo> ) with an initial content string of content. The newly created object is added as a sub-element of the annotation and returned.

  Parameters:
    `content` - The content body for the appinfo element.
  Returns:
    a reference to the newly created <appinfo> object

### addAppInfo

    public SOMAppInfo addAppInfo(SOMAppInfo appinfo)

### addInfo

    public SOMAppInfo addInfo(SOMAppInfo info)

  The addInfo method should be used to create child elements to the element. Valid children for are and . is represented by SOMAppInfo, and is represented by SOMDocumentation.

  Parameters:
    `info` - a SOMAppInfo object or SOMDocumentation object

### getChildren

    public Iterator getChildren()

  returns an iterator for all child elements

  Returns:
    Iterator

### getDocumentationElements

    public Iterator getDocumentationElements()

  returns an iterator for all documentation elements

  Returns:
    Iterator

### getAppInfoElements

    public Iterator getAppInfoElements()

  returns an iterator for all AppInfo elements

  Returns:
    Iterator

### toXML

    public void toXML(Writer rtn,
                      int indent)
               throws IOException

  Description copied from class: `SOMObject`
  Outputs a formatted XML representation of SOMObject.

  Specified by:
    `toXML` in class `SOMObject`
  Parameters:
    `rtn` - printable XML Schema
    `indent` - the indent level for formatting at which to start this schema object.
  Throws:
    `IOException` - if IOExcpetion is thrown by underlying java.io.Writer

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD