|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.LexGrid.commonTypes.Versionable
org.LexGrid.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 |
addPropertyQualifier(int index,
PropertyQualifier vPropertyQualifier)
|
void |
addPropertyQualifier(PropertyQualifier vPropertyQualifier)
|
void |
addSource(int index,
Source vSource)
|
void |
addSource(Source vSource)
|
void |
addUsageContext(int index,
java.lang.String vUsageContext)
|
void |
addUsageContext(java.lang.String vUsageContext)
|
java.util.Enumeration<PropertyQualifier> |
enumeratePropertyQualifier()
Method enumeratePropertyQualifier. |
java.util.Enumeration<Source> |
enumerateSource()
Method enumerateSource. |
java.util.Enumeration<java.lang.String> |
enumerateUsageContext()
Method enumerateUsageContext. |
java.lang.String |
getLanguage()
Returns the value of field 'language'. |
java.lang.String |
getPropertyId()
Returns the value of field 'propertyId'. |
java.lang.String |
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. |
int |
getPropertyQualifierCount()
Method getPropertyQualifierCount. |
java.lang.String |
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. |
int |
getSourceCount()
Method getSourceCount. |
java.lang.String[] |
getUsageContext()
Method getUsageContext.Returns the contents of the collection in an Array. |
java.lang.String |
getUsageContext(int index)
Method getUsageContext. |
int |
getUsageContextCount()
Method getUsageContextCount. |
Text |
getValue()
Returns the value of field 'value'. |
boolean |
isValid()
Method isValid. |
java.util.Iterator<PropertyQualifier> |
iteratePropertyQualifier()
Method iteratePropertyQualifier. |
java.util.Iterator<Source> |
iterateSource()
Method iterateSource. |
java.util.Iterator<java.lang.String> |
iterateUsageContext()
Method iterateUsageContext. |
void |
marshal(org.xml.sax.ContentHandler handler)
|
void |
marshal(java.io.Writer out)
|
void |
removeAllPropertyQualifier()
|
void |
removeAllSource()
|
void |
removeAllUsageContext()
|
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(java.lang.String vUsageContext)
Method removeUsageContext. |
java.lang.String |
removeUsageContextAt(int index)
Method removeUsageContextAt. |
void |
setLanguage(java.lang.String language)
Sets the value of field 'language'. |
void |
setPropertyId(java.lang.String propertyId)
Sets the value of field 'propertyId'. |
void |
setPropertyName(java.lang.String propertyName)
Sets the value of field 'propertyName'. |
void |
setPropertyQualifier(int index,
PropertyQualifier vPropertyQualifier)
|
void |
setPropertyQualifier(PropertyQualifier[] vPropertyQualifierArray)
|
void |
setPropertyType(java.lang.String propertyType)
Sets the value of field 'propertyType'. |
void |
setSource(int index,
Source vSource)
|
void |
setSource(Source[] vSourceArray)
|
void |
setUsageContext(int index,
java.lang.String vUsageContext)
|
void |
setUsageContext(java.lang.String[] vUsageContextArray)
|
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.commonTypes.Versionable |
---|
getEffectiveDate, getEntryState, getExpirationDate, getIsActive, getOwner, getStatus, isIsActive, setEffectiveDate, setEntryState, setExpirationDate, setIsActive, setOwner, setStatus, unmarshalVersionable |
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 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(java.lang.String vUsageContext) throws java.lang.IndexOutOfBoundsException
vUsageContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addUsageContext(int index, java.lang.String vUsageContext) throws java.lang.IndexOutOfBoundsException
index
- vUsageContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic java.util.Enumeration<PropertyQualifier> enumeratePropertyQualifier()
public java.util.Enumeration<Source> enumerateSource()
public java.util.Enumeration<java.lang.String> enumerateUsageContext()
public java.lang.String getLanguage()
public java.lang.String getPropertyId()
public java.lang.String 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 int getPropertyQualifierCount()
public java.lang.String 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 int getSourceCount()
public java.lang.String getUsageContext(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic java.lang.String[] 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 int getUsageContextCount()
public Text getValue()
public boolean isValid()
isValid
in class Versionable
public java.util.Iterator<PropertyQualifier> iteratePropertyQualifier()
public java.util.Iterator<Source> iterateSource()
public java.util.Iterator<java.lang.String> 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 removeAllPropertyQualifier()
public void removeAllSource()
public void removeAllUsageContext()
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(java.lang.String vUsageContext)
vUsageContext
-
public java.lang.String removeUsageContextAt(int index)
index
-
public void setLanguage(java.lang.String language)
language
- the value of field 'language'.public void setPropertyId(java.lang.String propertyId)
propertyId
- the value of field 'propertyId'.public void setPropertyName(java.lang.String 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 setPropertyType(java.lang.String 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 setUsageContext(int index, java.lang.String vUsageContext) throws java.lang.IndexOutOfBoundsException
index
- vUsageContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setUsageContext(java.lang.String[] vUsageContextArray)
vUsageContextArray
- 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 |