|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.mayo.edu.lgModel.LexGridBase
org.LexGrid.REST.commonTypes.Versionable
org.LexGrid.REST.commonTypes.Property
public class Property
A description, definition, annotation or other attribute that serves to further define or identify an resource.
Constructor Summary | |
---|---|
Property()
|
Method Summary | |
---|---|
void |
addPropertyLink(int index,
PropertyLinkInstance vPropertyLink)
|
void |
addPropertyLink(PropertyLinkInstance vPropertyLink)
|
void |
addPropertyQualifier(int index,
PropertyQualifier vPropertyQualifier)
|
void |
addPropertyQualifier(PropertyQualifier vPropertyQualifier)
|
void |
addSource(int index,
Source vSource)
|
void |
addSource(Source vSource)
|
void |
addUsageContext(Context vUsageContext)
|
void |
addUsageContext(int index,
Context vUsageContext)
|
java.util.Enumeration<? extends PropertyLinkInstance> |
enumeratePropertyLink()
Method enumeratePropertyLink. |
java.util.Enumeration<? extends PropertyQualifier> |
enumeratePropertyQualifier()
Method enumeratePropertyQualifier. |
java.util.Enumeration<? extends Source> |
enumerateSource()
Method enumerateSource. |
java.util.Enumeration<? extends Context> |
enumerateUsageContext()
Method enumerateUsageContext. |
Resource |
getContainingResource()
Returns the value of field 'containingResource'. |
Language |
getLanguage()
Returns the value of field 'language'. |
java.lang.String |
getPropertyId()
Returns the value of field 'propertyId'. |
PropertyLinkInstance[] |
getPropertyLink()
Method getPropertyLink.Returns the contents of the collection in an Array. |
PropertyLinkInstance |
getPropertyLink(int index)
Method getPropertyLink. |
java.util.List<PropertyLinkInstance> |
getPropertyLinkAsReference()
Method getPropertyLinkAsReference.Returns a reference to '_propertyLinkList'. |
int |
getPropertyLinkCount()
Method getPropertyLinkCount. |
PropertyName |
getPropertyName()
Returns the value of field 'propertyName'. |
PropertyQualifier[] |
getPropertyQualifier()
Method getPropertyQualifier.Returns the contents of the collection in an Array. |
PropertyQualifier |
getPropertyQualifier(int index)
Method getPropertyQualifier. |
java.util.List<PropertyQualifier> |
getPropertyQualifierAsReference()
Method getPropertyQualifierAsReference.Returns a reference to '_propertyQualifierList'. |
int |
getPropertyQualifierCount()
Method getPropertyQualifierCount. |
PropertyType |
getPropertyType()
Returns the value of field 'propertyType'. |
Source[] |
getSource()
Method getSource.Returns the contents of the collection in an Array. |
Source |
getSource(int index)
Method getSource. |
java.util.List<Source> |
getSourceAsReference()
Method getSourceAsReference.Returns a reference to '_sourceList'. |
int |
getSourceCount()
Method getSourceCount. |
Context[] |
getUsageContext()
Method getUsageContext.Returns the contents of the collection in an Array. |
Context |
getUsageContext(int index)
Method getUsageContext. |
java.util.List<Context> |
getUsageContextAsReference()
Method getUsageContextAsReference.Returns a reference to '_usageContextList'. |
int |
getUsageContextCount()
Method getUsageContextCount. |
Text |
getValue()
Returns the value of field 'value'. |
boolean |
isValid()
Method isValid. |
java.util.Iterator<? extends PropertyLinkInstance> |
iteratePropertyLink()
Method iteratePropertyLink. |
java.util.Iterator<? extends PropertyQualifier> |
iteratePropertyQualifier()
Method iteratePropertyQualifier. |
java.util.Iterator<? extends Source> |
iterateSource()
Method iterateSource. |
java.util.Iterator<? extends Context> |
iterateUsageContext()
Method iterateUsageContext. |
void |
marshal(org.xml.sax.ContentHandler handler)
|
void |
marshal(java.io.Writer out)
|
void |
removeAllPropertyLink()
|
void |
removeAllPropertyQualifier()
|
void |
removeAllSource()
|
void |
removeAllUsageContext()
|
boolean |
removePropertyLink(PropertyLinkInstance vPropertyLink)
Method removePropertyLink. |
PropertyLinkInstance |
removePropertyLinkAt(int index)
Method removePropertyLinkAt. |
boolean |
removePropertyQualifier(PropertyQualifier vPropertyQualifier)
Method removePropertyQualifier. |
PropertyQualifier |
removePropertyQualifierAt(int index)
Method removePropertyQualifierAt. |
boolean |
removeSource(Source vSource)
Method removeSource. |
Source |
removeSourceAt(int index)
Method removeSourceAt. |
boolean |
removeUsageContext(Context vUsageContext)
Method removeUsageContext. |
Context |
removeUsageContextAt(int index)
Method removeUsageContextAt. |
void |
setContainingResource(Resource containingResource)
Sets the value of field 'containingResource'. |
void |
setLanguage(Language language)
Sets the value of field 'language'. |
void |
setPropertyId(java.lang.String propertyId)
Sets the value of field 'propertyId'. |
void |
setPropertyLink(int index,
PropertyLinkInstance vPropertyLink)
|
void |
setPropertyLink(java.util.List<PropertyLinkInstance> vPropertyLinkList)
Sets the value of '_propertyLinkList' by copying the given Vector. |
void |
setPropertyLink(PropertyLinkInstance[] vPropertyLinkArray)
|
void |
setPropertyLinkAsReference(java.util.List<PropertyLinkInstance> propertyLinkList)
Deprecated. |
void |
setPropertyName(PropertyName propertyName)
Sets the value of field 'propertyName'. |
void |
setPropertyQualifier(int index,
PropertyQualifier vPropertyQualifier)
|
void |
setPropertyQualifier(java.util.List<PropertyQualifier> vPropertyQualifierList)
Sets the value of '_propertyQualifierList' by copying the given Vector. |
void |
setPropertyQualifier(PropertyQualifier[] vPropertyQualifierArray)
|
void |
setPropertyQualifierAsReference(java.util.List<PropertyQualifier> propertyQualifierList)
Deprecated. |
void |
setPropertyType(PropertyType propertyType)
Sets the value of field 'propertyType'. |
void |
setSource(int index,
Source vSource)
|
void |
setSource(java.util.List<Source> vSourceList)
Sets the value of '_sourceList' by copying the given Vector. |
void |
setSource(Source[] vSourceArray)
|
void |
setSourceAsReference(java.util.List<Source> sourceList)
Deprecated. |
void |
setUsageContext(Context[] vUsageContextArray)
|
void |
setUsageContext(int index,
Context vUsageContext)
|
void |
setUsageContext(java.util.List<Context> vUsageContextList)
Sets the value of '_usageContextList' by copying the given Vector. |
void |
setUsageContextAsReference(java.util.List<Context> usageContextList)
Deprecated. |
void |
setValue(Text value)
Sets the value of field 'value'. |
static Property |
unmarshalProperty(java.io.Reader reader)
Method unmarshalProperty. |
void |
validate()
|
Methods inherited from class org.LexGrid.REST.commonTypes.Versionable |
---|
getEffectiveDate, getEntryState, getExpirationDate, getIsActive, getOwner, getStatus, isIsActive, setEffectiveDate, setEntryState, setExpirationDate, setIsActive, setOwner, setStatus, unmarshalVersionable |
Methods inherited from class org.mayo.edu.lgModel.LexGridBase |
---|
getParent, setParent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Property()
Method Detail |
---|
public void addPropertyLink(PropertyLinkInstance vPropertyLink) throws java.lang.IndexOutOfBoundsException
vPropertyLink
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addPropertyLink(int index, PropertyLinkInstance vPropertyLink) throws java.lang.IndexOutOfBoundsException
index
- vPropertyLink
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addPropertyQualifier(PropertyQualifier vPropertyQualifier) throws java.lang.IndexOutOfBoundsException
vPropertyQualifier
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addPropertyQualifier(int index, PropertyQualifier vPropertyQualifier) throws java.lang.IndexOutOfBoundsException
index
- vPropertyQualifier
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addSource(Source vSource) throws java.lang.IndexOutOfBoundsException
vSource
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addSource(int index, Source vSource) throws java.lang.IndexOutOfBoundsException
index
- vSource
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addUsageContext(Context vUsageContext) throws java.lang.IndexOutOfBoundsException
vUsageContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addUsageContext(int index, Context vUsageContext) throws java.lang.IndexOutOfBoundsException
index
- vUsageContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic java.util.Enumeration<? extends PropertyLinkInstance> enumeratePropertyLink()
public java.util.Enumeration<? extends PropertyQualifier> enumeratePropertyQualifier()
public java.util.Enumeration<? extends Source> enumerateSource()
public java.util.Enumeration<? extends Context> enumerateUsageContext()
public Resource getContainingResource()
public Language getLanguage()
public java.lang.String getPropertyId()
public PropertyLinkInstance getPropertyLink(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic PropertyLinkInstance[] 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<PropertyLinkInstance> getPropertyLinkAsReference()
public int getPropertyLinkCount()
public PropertyName getPropertyName()
public PropertyQualifier getPropertyQualifier(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic PropertyQualifier[] getPropertyQualifier()
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<PropertyQualifier> getPropertyQualifierAsReference()
public int getPropertyQualifierCount()
public PropertyType getPropertyType()
public Source getSource(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic Source[] getSource()
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<Source> getSourceAsReference()
public int getSourceCount()
public Context getUsageContext(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic Context[] getUsageContext()
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<Context> getUsageContextAsReference()
public int getUsageContextCount()
public Text getValue()
public boolean isValid()
isValid
in class Versionable
public java.util.Iterator<? extends PropertyLinkInstance> iteratePropertyLink()
public java.util.Iterator<? extends PropertyQualifier> iteratePropertyQualifier()
public java.util.Iterator<? extends Source> iterateSource()
public java.util.Iterator<? extends Context> iterateUsageContext()
public void marshal(java.io.Writer out) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
marshal
in class Versionable
out
-
org.exolab.castor.xml.MarshalException
- if object is
null or if any SAXException is thrown during marshaling
org.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 Versionable
handler
-
java.io.IOException
- if an IOException occurs during
marshaling
org.exolab.castor.xml.ValidationException
- if this
object is an invalid instance according to the schema
org.exolab.castor.xml.MarshalException
- if object is
null or if any SAXException is thrown during marshalingpublic void removeAllPropertyLink()
public void removeAllPropertyQualifier()
public void removeAllSource()
public void removeAllUsageContext()
public boolean removePropertyLink(PropertyLinkInstance vPropertyLink)
vPropertyLink
-
public PropertyLinkInstance removePropertyLinkAt(int index)
index
-
public boolean removePropertyQualifier(PropertyQualifier vPropertyQualifier)
vPropertyQualifier
-
public PropertyQualifier removePropertyQualifierAt(int index)
index
-
public boolean removeSource(Source vSource)
vSource
-
public Source removeSourceAt(int index)
index
-
public boolean removeUsageContext(Context vUsageContext)
vUsageContext
-
public Context removeUsageContextAt(int index)
index
-
public void setContainingResource(Resource containingResource)
containingResource
- the value of field
'containingResource'.public void setLanguage(Language language)
language
- the value of field 'language'.public void setPropertyId(java.lang.String propertyId)
propertyId
- the value of field 'propertyId'.public void setPropertyLink(int index, PropertyLinkInstance vPropertyLink) throws java.lang.IndexOutOfBoundsException
index
- vPropertyLink
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setPropertyLink(PropertyLinkInstance[] vPropertyLinkArray)
vPropertyLinkArray
- public void setPropertyLink(java.util.List<PropertyLinkInstance> vPropertyLinkList)
vPropertyLinkList
- the Vector to copy.public void setPropertyLinkAsReference(java.util.List<PropertyLinkInstance> propertyLinkList)
propertyLinkList
- the Vector to set.public void setPropertyName(PropertyName propertyName)
propertyName
- the value of field 'propertyName'.public void setPropertyQualifier(int index, PropertyQualifier vPropertyQualifier) throws java.lang.IndexOutOfBoundsException
index
- vPropertyQualifier
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setPropertyQualifier(PropertyQualifier[] vPropertyQualifierArray)
vPropertyQualifierArray
- public void setPropertyQualifier(java.util.List<PropertyQualifier> vPropertyQualifierList)
vPropertyQualifierList
- the Vector to copy.public void setPropertyQualifierAsReference(java.util.List<PropertyQualifier> propertyQualifierList)
propertyQualifierList
- the Vector to set.public void setPropertyType(PropertyType propertyType)
propertyType
- the value of field 'propertyType'.public void setSource(int index, Source vSource) throws java.lang.IndexOutOfBoundsException
index
- vSource
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setSource(Source[] vSourceArray)
vSourceArray
- public void setSource(java.util.List<Source> vSourceList)
vSourceList
- the Vector to copy.public void setSourceAsReference(java.util.List<Source> sourceList)
sourceList
- the Vector to set.public void setUsageContext(int index, Context vUsageContext) throws java.lang.IndexOutOfBoundsException
index
- vUsageContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setUsageContext(Context[] vUsageContextArray)
vUsageContextArray
- public void setUsageContext(java.util.List<Context> vUsageContextList)
vUsageContextList
- the Vector to copy.public void setUsageContextAsReference(java.util.List<Context> usageContextList)
usageContextList
- the Vector to set.public void setValue(Text value)
value
- the value of field 'value'.public static Property unmarshalProperty(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 marshaling
org.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 Versionable
org.exolab.castor.xml.ValidationException
- if this
object is an invalid instance according to the schema
|
Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |