org.LexGrid.REST.concepts
Class Presentation

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.REST.commonTypes.Versionable
          extended by org.LexGrid.REST.commonTypes.Property
              extended by org.LexGrid.REST.concepts.Presentation
All Implemented Interfaces:
java.io.Serializable

public class Presentation
extends Property
implements java.io.Serializable

A property ths represents or designates the meaning of the entityCode. The propertyType of presentation must be "presentation"

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
Presentation()
           
 
Method Summary
 DegreeOfFidelity getDegreeOfFidelity()
          Returns the value of field 'degreeOfFidelity'.
 java.lang.Boolean getIsPreferred()
          Returns the value of field 'isPreferred'.
 java.lang.Boolean getMatchIfNoContext()
          Returns the value of field 'matchIfNoContext'.
 RepresentationalForm getRepresentationalForm()
          Returns the value of field 'representationalForm'.
 java.lang.Boolean isIsPreferred()
          Returns the value of field 'isPreferred'.
 java.lang.Boolean isMatchIfNoContext()
          Returns the value of field 'matchIfNoContext'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setDegreeOfFidelity(DegreeOfFidelity degreeOfFidelity)
          Sets the value of field 'degreeOfFidelity'.
 void setIsPreferred(java.lang.Boolean isPreferred)
          Sets the value of field 'isPreferred'.
 void setMatchIfNoContext(java.lang.Boolean matchIfNoContext)
          Sets the value of field 'matchIfNoContext'.
 void setRepresentationalForm(RepresentationalForm representationalForm)
          Sets the value of field 'representationalForm'.
static Presentation unmarshalPresentation(java.io.Reader reader)
          Method unmarshalPresentation.
 void validate()
           
 
Methods inherited from class org.LexGrid.REST.commonTypes.Property
addPropertyLink, addPropertyLink, addPropertyQualifier, addPropertyQualifier, addSource, addSource, addUsageContext, addUsageContext, enumeratePropertyLink, enumeratePropertyQualifier, enumerateSource, enumerateUsageContext, getContainingResource, getLanguage, getPropertyId, getPropertyLink, getPropertyLink, getPropertyLinkAsReference, getPropertyLinkCount, getPropertyName, getPropertyQualifier, getPropertyQualifier, getPropertyQualifierAsReference, getPropertyQualifierCount, getPropertyType, getSource, getSource, getSourceAsReference, getSourceCount, getUsageContext, getUsageContext, getUsageContextAsReference, getUsageContextCount, getValue, iteratePropertyLink, iteratePropertyQualifier, iterateSource, iterateUsageContext, removeAllPropertyLink, removeAllPropertyQualifier, removeAllSource, removeAllUsageContext, removePropertyLink, removePropertyLinkAt, removePropertyQualifier, removePropertyQualifierAt, removeSource, removeSourceAt, removeUsageContext, removeUsageContextAt, setContainingResource, setLanguage, setPropertyId, setPropertyLink, setPropertyLink, setPropertyLink, setPropertyLinkAsReference, setPropertyName, setPropertyQualifier, setPropertyQualifier, setPropertyQualifier, setPropertyQualifierAsReference, setPropertyType, setSource, setSource, setSource, setSourceAsReference, setUsageContext, setUsageContext, setUsageContext, setUsageContextAsReference, setValue, unmarshalProperty
 
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

Presentation

public Presentation()
Method Detail

getDegreeOfFidelity

public DegreeOfFidelity getDegreeOfFidelity()
Returns the value of field 'degreeOfFidelity'. The field 'degreeOfFidelity' has the following description: A local identifier that states how closely a term approximates the intended meaning of an entry code. degreeOfFidelity must match a local id of a supportedDegreeOfFidelity in the corresponding mappings section.

Returns:
the value of field 'DegreeOfFidelity'.

getIsPreferred

public java.lang.Boolean getIsPreferred()
Returns the value of field 'isPreferred'. The field 'isPreferred' has the following description: True means that, if the text meets the selection criteria, it should be the preferred form. For a given language there should be only one preferred presentation.

Returns:
the value of field 'IsPreferred'.

getMatchIfNoContext

public java.lang.Boolean getMatchIfNoContext()
Returns the value of field 'matchIfNoContext'. The field 'matchIfNoContext' has the following description: True means that this presentation is valid in a acontextual setting - that it is always valid in the given language. Default: true if there are no property usageContexts, false otherwise.

Returns:
the value of field 'MatchIfNoContext'.

getRepresentationalForm

public RepresentationalForm getRepresentationalForm()
Returns the value of field 'representationalForm'. The field 'representationalForm' has the following description: A local identifier that states how the term represents the concept (abbrev, acronym, etc.) representationalForm must match a local id of a representationalForm in the corresponding mappings section.

Returns:
the value of field 'RepresentationalForm'.

isIsPreferred

public java.lang.Boolean isIsPreferred()
Returns the value of field 'isPreferred'. The field 'isPreferred' has the following description: True means that, if the text meets the selection criteria, it should be the preferred form. For a given language there should be only one preferred presentation.

Returns:
the value of field 'IsPreferred'.

isMatchIfNoContext

public java.lang.Boolean isMatchIfNoContext()
Returns the value of field 'matchIfNoContext'. The field 'matchIfNoContext' has the following description: True means that this presentation is valid in a acontextual setting - that it is always valid in the given language. Default: true if there are no property usageContexts, false otherwise.

Returns:
the value of field 'MatchIfNoContext'.

isValid

public boolean isValid()
Method isValid.

Overrides:
isValid in class Property
Returns:
true if this object is valid according to the schema

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Overrides:
marshal in class Property
Parameters:
out -
Throws:
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 schema

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Overrides:
marshal in class Property
Parameters:
handler -
Throws:
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 marshaling

setDegreeOfFidelity

public void setDegreeOfFidelity(DegreeOfFidelity degreeOfFidelity)
Sets the value of field 'degreeOfFidelity'. The field 'degreeOfFidelity' has the following description: A local identifier that states how closely a term approximates the intended meaning of an entry code. degreeOfFidelity must match a local id of a supportedDegreeOfFidelity in the corresponding mappings section.

Parameters:
degreeOfFidelity - the value of field 'degreeOfFidelity'

setIsPreferred

public void setIsPreferred(java.lang.Boolean isPreferred)
Sets the value of field 'isPreferred'. The field 'isPreferred' has the following description: True means that, if the text meets the selection criteria, it should be the preferred form. For a given language there should be only one preferred presentation.

Parameters:
isPreferred - the value of field 'isPreferred'.

setMatchIfNoContext

public void setMatchIfNoContext(java.lang.Boolean matchIfNoContext)
Sets the value of field 'matchIfNoContext'. The field 'matchIfNoContext' has the following description: True means that this presentation is valid in a acontextual setting - that it is always valid in the given language. Default: true if there are no property usageContexts, false otherwise.

Parameters:
matchIfNoContext - the value of field 'matchIfNoContext'

setRepresentationalForm

public void setRepresentationalForm(RepresentationalForm representationalForm)
Sets the value of field 'representationalForm'. The field 'representationalForm' has the following description: A local identifier that states how the term represents the concept (abbrev, acronym, etc.) representationalForm must match a local id of a representationalForm in the corresponding mappings section.

Parameters:
representationalForm - the value of field 'representationalForm'.

unmarshalPresentation

public static Presentation unmarshalPresentation(java.io.Reader reader)
                                          throws org.exolab.castor.xml.MarshalException,
                                                 org.exolab.castor.xml.ValidationException
Method unmarshalPresentation.

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.REST.concepts.Presentatio
Throws:
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 schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
Overrides:
validate in class Property
Throws:
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.