public class Entity extends VersionableAndDescribable implements java.io.Serializable
Type | Property and Description |
---|---|
java.util.Enumeration<? extends Property> |
enumerate
Method enumerateProperty.
|
java.util.Iterator<? extends Property> |
iterate
Method iterateProperty.
|
Constructor and Description |
---|
Entity() |
Modifier and Type | Method and Description |
---|---|
void |
addAnyProperties(java.util.List<Property> properties)
Adds all of the Properties (or subclasses of Property) in a given List to this Entity.
|
void |
addAnyProperty(Property property)
Adds any Property to this Entity.
|
void |
addComment(Comment vComment) |
void |
addComment(int index,
Comment vComment) |
void |
addDefinition(Definition vDefinition) |
void |
addDefinition(int index,
Definition vDefinition) |
void |
addEntityType(int index,
java.lang.String vEntityType) |
void |
addEntityType(java.lang.String vEntityType) |
void |
addPresentation(int index,
Presentation vPresentation) |
void |
addPresentation(Presentation vPresentation) |
void |
addProperty(int index,
Property vProperty) |
void |
addProperty(Property vProperty) |
void |
addPropertyLink(int index,
PropertyLink vPropertyLink) |
void |
addPropertyLink(PropertyLink vPropertyLink) |
java.util.Enumeration<? extends Comment> |
enumerateComment()
Method enumerateComment.
|
java.util.Enumeration<? extends Definition> |
enumerateDefinition()
Method enumerateDefinition.
|
java.util.Enumeration<? extends java.lang.String> |
enumerateEntityType()
Method enumerateEntityType.
|
java.util.Enumeration<? extends Presentation> |
enumeratePresentation()
Method enumeratePresentation.
|
java.util.Enumeration<? extends Property> |
enumerateProperty()
Method enumerateProperty.
|
java.util.Enumeration<? extends PropertyLink> |
enumeratePropertyLink()
Method enumeratePropertyLink.
|
Property[] |
getAllProperties()
Returns all of the Properties (and subclasses of Property) contained by this Entity.
|
Comment[] |
getComment()
Method getComment.Returns the contents of the collection in
an Array.
|
Comment |
getComment(int index)
Method getComment.
|
java.util.List<Comment> |
getCommentAsReference()
Method getCommentAsReference.Returns a reference to
'_commentList'.
|
int |
getCommentCount()
Method getCommentCount.
|
Definition[] |
getDefinition()
Method getDefinition.Returns the contents of the collection
in an Array.
|
Definition |
getDefinition(int index)
Method getDefinition.
|
java.util.List<Definition> |
getDefinitionAsReference()
Method getDefinitionAsReference.Returns a reference to
'_definitionList'.
|
int |
getDefinitionCount()
Method getDefinitionCount.
|
java.lang.String |
getEntityCode()
Returns the value of field 'entityCode'.
|
java.lang.String |
getEntityCodeNamespace()
Returns the value of field 'entityCodeNamespace'.
|
java.lang.String[] |
getEntityType()
Method getEntityType.Returns the contents of the collection
in an Array.
|
java.lang.String |
getEntityType(int index)
Method getEntityType.
|
java.util.List<java.lang.String> |
getEntityTypeAsReference()
Method getEntityTypeAsReference.Returns a reference to
'_entityTypeList'.
|
int |
getEntityTypeCount()
Method getEntityTypeCount.
|
java.lang.Boolean |
getIsAnonymous()
Returns the value of field 'isAnonymous'.
|
java.lang.Boolean |
getIsDefined()
Returns the value of field 'isDefined'.
|
Presentation[] |
getPresentation()
Method getPresentation.Returns the contents of the
collection in an Array.
|
Presentation |
getPresentation(int index)
Method getPresentation.
|
java.util.List<Presentation> |
getPresentationAsReference()
Method getPresentationAsReference.Returns a reference to
'_presentationList'.
|
int |
getPresentationCount()
Method getPresentationCount.
|
Property[] |
getProperty()
Method getProperty.Returns the contents of the collection in
an Array.
|
Property |
getProperty(int index)
Method getProperty.
|
java.util.List<Property> |
getPropertyAsReference()
Method getPropertyAsReference.Returns a reference to
'_propertyList'.
|
int |
getPropertyCount()
Method getPropertyCount.
|
PropertyLink[] |
getPropertyLink()
Method getPropertyLink.Returns the contents of the
collection in an Array.
|
PropertyLink |
getPropertyLink(int index)
Method getPropertyLink.
|
java.util.List<PropertyLink> |
getPropertyLinkAsReference()
Method getPropertyLinkAsReference.Returns a reference to
'_propertyLinkList'.
|
int |
getPropertyLinkCount()
Method getPropertyLinkCount.
|
java.lang.Boolean |
isIsAnonymous()
Returns the value of field 'isAnonymous'.
|
java.lang.Boolean |
isIsDefined()
Returns the value of field 'isDefined'.
|
boolean |
isValid()
Method isValid.
|
java.util.Iterator<? extends Comment> |
iterateComment()
Method iterateComment.
|
java.util.Iterator<? extends Definition> |
iterateDefinition()
Method iterateDefinition.
|
java.util.Iterator<? extends java.lang.String> |
iterateEntityType()
Method iterateEntityType.
|
java.util.Iterator<? extends Presentation> |
iteratePresentation()
Method iteratePresentation.
|
java.util.Iterator<? extends Property> |
iterateProperty()
Method iterateProperty.
|
java.util.Iterator<? extends PropertyLink> |
iteratePropertyLink()
Method iteratePropertyLink.
|
void |
marshal(org.xml.sax.ContentHandler handler) |
void |
marshal(java.io.Writer out) |
void |
removeAllComment() |
void |
removeAllDefinition() |
void |
removeAllEntityType() |
void |
removeAllPresentation() |
void |
removeAllProperty() |
void |
removeAllPropertyLink() |
boolean |
removeComment(Comment vComment)
Method removeComment.
|
Comment |
removeCommentAt(int index)
Method removeCommentAt.
|
boolean |
removeDefinition(Definition vDefinition)
Method removeDefinition.
|
Definition |
removeDefinitionAt(int index)
Method removeDefinitionAt.
|
boolean |
removeEntityType(java.lang.String vEntityType)
Method removeEntityType.
|
java.lang.String |
removeEntityTypeAt(int index)
Method removeEntityTypeAt.
|
boolean |
removePresentation(Presentation vPresentation)
Method removePresentation.
|
Presentation |
removePresentationAt(int index)
Method removePresentationAt.
|
boolean |
removeProperty(Property vProperty)
Method removeProperty.
|
Property |
removePropertyAt(int index)
Method removePropertyAt.
|
boolean |
removePropertyLink(PropertyLink vPropertyLink)
Method removePropertyLink.
|
PropertyLink |
removePropertyLinkAt(int index)
Method removePropertyLinkAt.
|
void |
setComment(Comment[] vCommentArray) |
void |
setComment(int index,
Comment vComment) |
void |
setComment(java.util.List<Comment> vCommentList)
Sets the value of '_commentList' by copying the given
Vector.
|
void |
setCommentAsReference(java.util.List<Comment> commentList)
Deprecated.
|
void |
setDefinition(Definition[] vDefinitionArray) |
void |
setDefinition(int index,
Definition vDefinition) |
void |
setDefinition(java.util.List<Definition> vDefinitionList)
Sets the value of '_definitionList' by copying the given
Vector.
|
void |
setDefinitionAsReference(java.util.List<Definition> definitionList)
Deprecated.
|
void |
setEntityCode(java.lang.String entityCode)
Sets the value of field 'entityCode'.
|
void |
setEntityCodeNamespace(java.lang.String entityCodeNamespace)
Sets the value of field 'entityCodeNamespace'.
|
void |
setEntityType(int index,
java.lang.String vEntityType) |
void |
setEntityType(java.util.List<java.lang.String> vEntityTypeList)
Sets the value of '_entityTypeList' by copying the given
Vector.
|
void |
setEntityType(java.lang.String[] vEntityTypeArray) |
void |
setEntityTypeAsReference(java.util.List<java.lang.String> entityTypeList)
Deprecated.
|
void |
setIsAnonymous(java.lang.Boolean isAnonymous)
Sets the value of field 'isAnonymous'.
|
void |
setIsDefined(java.lang.Boolean isDefined)
Sets the value of field 'isDefined'.
|
void |
setPresentation(int index,
Presentation vPresentation) |
void |
setPresentation(java.util.List<Presentation> vPresentationList)
Sets the value of '_presentationList' by copying the given
Vector.
|
void |
setPresentation(Presentation[] vPresentationArray) |
void |
setPresentationAsReference(java.util.List<Presentation> presentationList)
Deprecated.
|
void |
setProperty(int index,
Property vProperty) |
void |
setProperty(java.util.List<Property> vPropertyList)
Sets the value of '_propertyList' by copying the given
Vector.
|
void |
setProperty(Property[] vPropertyArray) |
void |
setPropertyAsReference(java.util.List<Property> propertyList)
Deprecated.
|
void |
setPropertyLink(int index,
PropertyLink vPropertyLink) |
void |
setPropertyLink(java.util.List<PropertyLink> vPropertyLinkList)
Sets the value of '_propertyLinkList' by copying the given
Vector.
|
void |
setPropertyLink(PropertyLink[] vPropertyLinkArray) |
void |
setPropertyLinkAsReference(java.util.List<PropertyLink> propertyLinkList)
Deprecated.
|
static Entity |
unmarshalEntity(java.io.Reader reader)
Method unmarshalEntity.
|
void |
validate() |
getEntityDescription, setEntityDescription, unmarshalVersionableAndDescribable
getEffectiveDate, getEntryState, getExpirationDate, getIsActive, getOwner, getStatus, isIsActive, setEffectiveDate, setEntryState, setExpirationDate, setIsActive, setOwner, setStatus, unmarshalVersionable
getParent, setParent
public java.util.Enumeration<? extends Property> enumerateProperty
public java.util.Iterator<? extends Property> iterateProperty
public void addComment(Comment vComment) throws java.lang.IndexOutOfBoundsException
vComment
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addComment(int index, Comment vComment) throws java.lang.IndexOutOfBoundsException
index
- vComment
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addDefinition(Definition vDefinition) throws java.lang.IndexOutOfBoundsException
vDefinition
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addDefinition(int index, Definition vDefinition) throws java.lang.IndexOutOfBoundsException
index
- vDefinition
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addEntityType(java.lang.String vEntityType) throws java.lang.IndexOutOfBoundsException
vEntityType
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addEntityType(int index, java.lang.String vEntityType) throws java.lang.IndexOutOfBoundsException
index
- vEntityType
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addPresentation(Presentation vPresentation) throws java.lang.IndexOutOfBoundsException
vPresentation
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addPresentation(int index, Presentation vPresentation) throws java.lang.IndexOutOfBoundsException
index
- vPresentation
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addProperty(Property vProperty) throws java.lang.IndexOutOfBoundsException
vProperty
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addProperty(int index, Property vProperty) throws java.lang.IndexOutOfBoundsException
index
- vProperty
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addPropertyLink(PropertyLink vPropertyLink) throws java.lang.IndexOutOfBoundsException
vPropertyLink
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addPropertyLink(int index, PropertyLink vPropertyLink) throws java.lang.IndexOutOfBoundsException
index
- vPropertyLink
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic java.util.Enumeration<? extends Comment> enumerateComment()
public java.util.Enumeration<? extends Definition> enumerateDefinition()
public java.util.Enumeration<? extends java.lang.String> enumerateEntityType()
public java.util.Enumeration<? extends Presentation> enumeratePresentation()
public java.util.Enumeration<? extends Property> enumerateProperty()
public java.util.Enumeration<? extends PropertyLink> enumeratePropertyLink()
public Comment getComment(int index) throws java.lang.IndexOutOfBoundsException
index
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic Comment[] getComment()
Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
public java.util.List<Comment> getCommentAsReference()
public int getCommentCount()
public Definition getDefinition(int index) throws java.lang.IndexOutOfBoundsException
index
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic Definition[] getDefinition()
Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
public java.util.List<Definition> getDefinitionAsReference()
public int getDefinitionCount()
public java.lang.String getEntityCode()
public java.lang.String getEntityCodeNamespace()
public java.lang.String getEntityType(int index) throws java.lang.IndexOutOfBoundsException
index
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic java.lang.String[] getEntityType()
Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
public java.util.List<java.lang.String> getEntityTypeAsReference()
public int getEntityTypeCount()
public java.lang.Boolean getIsAnonymous()
public java.lang.Boolean getIsDefined()
public Presentation getPresentation(int index) throws java.lang.IndexOutOfBoundsException
index
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic Presentation[] getPresentation()
Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
public java.util.List<Presentation> getPresentationAsReference()
public int getPresentationCount()
public Property getProperty(int index) throws java.lang.IndexOutOfBoundsException
index
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic Property[] getProperty()
Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
public java.util.List<Property> getPropertyAsReference()
public int getPropertyCount()
public PropertyLink getPropertyLink(int index) throws java.lang.IndexOutOfBoundsException
index
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic PropertyLink[] getPropertyLink()
Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
public java.util.List<PropertyLink> getPropertyLinkAsReference()
public int getPropertyLinkCount()
public java.lang.Boolean isIsAnonymous()
public java.lang.Boolean isIsDefined()
public boolean isValid()
isValid
in class VersionableAndDescribable
public java.util.Iterator<? extends Comment> iterateComment()
public java.util.Iterator<? extends Definition> iterateDefinition()
public java.util.Iterator<? extends java.lang.String> iterateEntityType()
public java.util.Iterator<? extends Presentation> iteratePresentation()
public java.util.Iterator<? extends Property> iterateProperty()
public java.util.Iterator<? extends PropertyLink> iteratePropertyLink()
public void marshal(java.io.Writer out) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
marshal
in class VersionableAndDescribable
out
- org.exolab.castor.xml.MarshalException
- if object is
null or if any SAXException is thrown during marshalingorg.exolab.castor.xml.ValidationException
- if this
object is an invalid instance according to the schemapublic void marshal(org.xml.sax.ContentHandler handler) throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
marshal
in class VersionableAndDescribable
handler
- java.io.IOException
- if an IOException occurs during
marshalingorg.exolab.castor.xml.ValidationException
- if this
object is an invalid instance according to the schemaorg.exolab.castor.xml.MarshalException
- if object is
null or if any SAXException is thrown during marshalingpublic void removeAllComment()
public void removeAllDefinition()
public void removeAllEntityType()
public void removeAllPresentation()
public void removeAllProperty()
public void removeAllPropertyLink()
public boolean removeComment(Comment vComment)
vComment
- public Comment removeCommentAt(int index)
index
- public boolean removeDefinition(Definition vDefinition)
vDefinition
- public Definition removeDefinitionAt(int index)
index
- public boolean removeEntityType(java.lang.String vEntityType)
vEntityType
- public java.lang.String removeEntityTypeAt(int index)
index
- public boolean removePresentation(Presentation vPresentation)
vPresentation
- public Presentation removePresentationAt(int index)
index
- public boolean removeProperty(Property vProperty)
vProperty
- public Property removePropertyAt(int index)
index
- public boolean removePropertyLink(PropertyLink vPropertyLink)
vPropertyLink
- public PropertyLink removePropertyLinkAt(int index)
index
- public void setComment(int index, Comment vComment) throws java.lang.IndexOutOfBoundsException
index
- vComment
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setComment(Comment[] vCommentArray)
vCommentArray
- public void setComment(java.util.List<Comment> vCommentList)
vCommentList
- the Vector to copy.public void setCommentAsReference(java.util.List<Comment> commentList)
commentList
- the Vector to set.public void setDefinition(int index, Definition vDefinition) throws java.lang.IndexOutOfBoundsException
index
- vDefinition
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setDefinition(Definition[] vDefinitionArray)
vDefinitionArray
- public void setDefinition(java.util.List<Definition> vDefinitionList)
vDefinitionList
- the Vector to copy.public void setDefinitionAsReference(java.util.List<Definition> definitionList)
definitionList
- the Vector to set.public void setEntityCode(java.lang.String entityCode)
entityCode
- the value of field 'entityCode'.public void setEntityCodeNamespace(java.lang.String entityCodeNamespace)
entityCodeNamespace
- the value of field
'entityCodeNamespace'.public void setEntityType(int index, java.lang.String vEntityType) throws java.lang.IndexOutOfBoundsException
index
- vEntityType
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setEntityType(java.lang.String[] vEntityTypeArray)
vEntityTypeArray
- public void setEntityType(java.util.List<java.lang.String> vEntityTypeList)
vEntityTypeList
- the Vector to copy.public void setEntityTypeAsReference(java.util.List<java.lang.String> entityTypeList)
entityTypeList
- the Vector to set.public void setIsAnonymous(java.lang.Boolean isAnonymous)
isAnonymous
- the value of field 'isAnonymous'.public void setIsDefined(java.lang.Boolean isDefined)
isDefined
- the value of field 'isDefined'.public void setPresentation(int index, Presentation vPresentation) throws java.lang.IndexOutOfBoundsException
index
- vPresentation
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setPresentation(Presentation[] vPresentationArray)
vPresentationArray
- public void setPresentation(java.util.List<Presentation> vPresentationList)
vPresentationList
- the Vector to copy.public void setPresentationAsReference(java.util.List<Presentation> presentationList)
presentationList
- the Vector to set.public void setProperty(int index, Property vProperty) throws java.lang.IndexOutOfBoundsException
index
- vProperty
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setProperty(Property[] vPropertyArray)
vPropertyArray
- public void setProperty(java.util.List<Property> vPropertyList)
vPropertyList
- the Vector to copy.public void setPropertyAsReference(java.util.List<Property> propertyList)
propertyList
- the Vector to set.public void setPropertyLink(int index, PropertyLink vPropertyLink) throws java.lang.IndexOutOfBoundsException
index
- vPropertyLink
- java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setPropertyLink(PropertyLink[] vPropertyLinkArray)
vPropertyLinkArray
- public void setPropertyLink(java.util.List<PropertyLink> vPropertyLinkList)
vPropertyLinkList
- the Vector to copy.public void setPropertyLinkAsReference(java.util.List<PropertyLink> propertyLinkList)
propertyLinkList
- the Vector to set.public static Entity unmarshalEntity(java.io.Reader reader) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
reader
- org.exolab.castor.xml.MarshalException
- if object is
null or if any SAXException is thrown during marshalingorg.exolab.castor.xml.ValidationException
- if this
object is an invalid instance according to the schemapublic void validate() throws org.exolab.castor.xml.ValidationException
validate
in class VersionableAndDescribable
org.exolab.castor.xml.ValidationException
- if this
object is an invalid instance according to the schemapublic Property[] getAllProperties()
public void addAnyProperties(java.util.List<Property> properties)
property
- The List of Properties to be added (List may contain subclass of Property).public void addAnyProperty(Property property)
property
- The Property to be added (may be a subclass of Property).