|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectbiz.c24.io.api.data.Annotation
public class Annotation
A group of documentation and application information objects used to annotate data models. Documentation objects generally contain human-readable narrative whereas AppInfo objects are used to store data destined for machine interpretation.
Warning: Serialized objects of this class or of a deployed class which is derived from it may not be compatible with future releases of C24 Integreation Objects. The current serialization support is appropriate for short term storage or RMI between applications running the same version of C24 Integreation Objects.
Constructor Summary | |
---|---|
Annotation()
Constructs a new instance. |
|
Annotation(Annotation clone)
Constructs a new instance cloned from clone . |
|
Annotation(Documentation[] docArr,
AppInfo[] appinfoArr)
Creates a new instances with supplied arrays of documentation and appinfo objects. |
|
Annotation(String description)
Constructs a new instance with a single description. |
Method Summary | |
---|---|
void |
addAppInfo(AppInfo appInfo)
Adds an appinfo object. |
void |
addDocumentation(Documentation doc)
Adds a documentation object. |
AppInfo |
getAppInfo(int index)
Returns the appinfo object at index . |
int |
getAppInfoCount()
Returns the number of appinfo items. |
Documentation |
getDocumentation(int index)
Returns the documentation object at index . |
int |
getDocumentationCount()
Returns the number of documentation objects. |
void |
removeAppInfo(int index)
Removes an appinfo object. |
void |
removeDocumentation(int index)
Removes a documentation object. |
String |
toString()
Returns a description of this annotation. |
String |
toString(String lang)
Returns a description of this annotation taken using the specified language. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Annotation()
public Annotation(String description)
description
- The description to be added as a documentation node.public Annotation(Documentation[] docArr, AppInfo[] appinfoArr)
docArr
- The array of documentation objects.appinfoArr
- The array of appinfo objects.public Annotation(Annotation clone)
clone
.
clone
- The object to clone.Method Detail |
---|
public int getDocumentationCount()
public Documentation getDocumentation(int index)
index
.
index
- The index of the documentation object to return.
index
.
IndexOutOfBoundsException
- if the index is out of range (index < 0 || index >= getDocumentationCount()).public int getAppInfoCount()
public AppInfo getAppInfo(int index)
index
.
index
- The index of the appinfo object to return.
index
.
IndexOutOfBoundsException
- if the index is out of range (index < 0 || index >= getAppInfoCount()).public void addDocumentation(Documentation doc)
doc
- The new object.public void removeDocumentation(int index)
index
- The index of the documentation object to be removed.
IndexOutOfBoundsException
- if the index is out of range (index < 0 || index >= getDocumentationCount()).public void addAppInfo(AppInfo appInfo)
appInfo
- The new object.public void removeAppInfo(int index)
index
- The index of the appinfo object to be removed.
IndexOutOfBoundsException
- if the index is out of range (index < 0 || index >= getAppInfoCount()).public String toString(String lang)
The string returned will contain the content of the first documentation object found in the specified languge. If none is found, then a documentation with no language specified will be returned if one exists, otherwise the first documentation found will be returned.
lang
- The language to use.
public String toString()
The string returned will contain the content of the first documentation object constituting this object.
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |