StructureMap.StructureMapStructureComponent (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.dstu3.model.Base
- - org.hl7.fhir.dstu3.model.Element
  - - org.hl7.fhir.dstu3.model.BackboneElement
    - - org.hl7.fhir.dstu3.model.StructureMap.StructureMapStructureComponent

All Implemented Interfaces:

IElement, Serializable, IBase, IBaseBackboneElement, IBaseElement, IBaseHasExtensions, IBaseHasModifierExtensions

Enclosing class:

StructureMap
```
public static class StructureMap.StructureMapStructureComponent
extends BackboneElement
implements IBaseBackboneElement
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected StringType`	`alias` The name used for this type in the map.
`protected StringType`	`documentation` Documentation that describes how the structure is used in the mapping.
`protected Enumeration<StructureMap.StructureMapModelMode>`	`mode` How the referenced structure is used in this mapping.
`protected UriType`	`url` The canonical URL that identifies the structure.

Fields inherited from class org.hl7.fhir.dstu3.model.BackboneElement
modifierExtension

Fields inherited from class org.hl7.fhir.dstu3.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description
`StructureMapStructureComponent()` Constructor
`StructureMapStructureComponent(UriType url, Enumeration<StructureMap.StructureMapModelMode> mode)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`StructureMap.StructureMapStructureComponent`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`String`	`getAlias()`
`StringType`	`getAliasElement()`
`String`	`getDocumentation()`
`StringType`	`getDocumentationElement()`
`StructureMap.StructureMapModelMode`	`getMode()`
`Enumeration<StructureMap.StructureMapModelMode>`	`getModeElement()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`String[]`	`getTypesForProperty(int hash, String name)`
`String`	`getUrl()`
`UriType`	`getUrlElement()`
`boolean`	`hasAlias()`
`boolean`	`hasAliasElement()`
`boolean`	`hasDocumentation()`
`boolean`	`hasDocumentationElement()`
`boolean`	`hasMode()`
`boolean`	`hasModeElement()`
`boolean`	`hasUrl()`
`boolean`	`hasUrlElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`StructureMap.StructureMapStructureComponent`	`setAlias(String value)`
`StructureMap.StructureMapStructureComponent`	`setAliasElement(StringType value)`
`StructureMap.StructureMapStructureComponent`	`setDocumentation(String value)`
`StructureMap.StructureMapStructureComponent`	`setDocumentationElement(StringType value)`
`StructureMap.StructureMapStructureComponent`	`setMode(StructureMap.StructureMapModelMode value)`
`StructureMap.StructureMapStructureComponent`	`setModeElement(Enumeration<StructureMap.StructureMapModelMode> value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`StructureMap.StructureMapStructureComponent`	`setUrl(String value)`
`StructureMap.StructureMapStructureComponent`	`setUrlElement(UriType value)`

Methods inherited from class org.hl7.fhir.dstu3.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.dstu3.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension

- Field Detail
  - url
```
protected UriType url
```
    The canonical URL that identifies the structure.
  - mode
```
protected Enumeration<StructureMap.StructureMapModelMode> mode
```
    How the referenced structure is used in this mapping.
  - alias
```
protected StringType alias
```
    The name used for this type in the map.
  - documentation
```
protected StringType documentation
```
    Documentation that describes how the structure is used in the mapping.
- Constructor Detail
  - StructureMapStructureComponent
```
public StructureMapStructureComponent()
```
    Constructor
  - StructureMapStructureComponent
```
public StructureMapStructureComponent(UriType url,
                                      Enumeration<StructureMap.StructureMapModelMode> mode)
```
    Constructor
- Method Detail
  - getUrlElement
```
public UriType getUrlElement()
```
    Returns:
    
    url (The canonical URL that identifies the structure.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
  - hasUrlElement
```
public boolean hasUrlElement()
```
  - hasUrl
```
public boolean hasUrl()
```
  - setUrlElement
```
public StructureMap.StructureMapStructureComponent setUrlElement(UriType value)
```
    Parameters:
    
    value - url (The canonical URL that identifies the structure.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
  - getUrl
```
public String getUrl()
```
    Returns:
    
    The canonical URL that identifies the structure.
  - setUrl
```
public StructureMap.StructureMapStructureComponent setUrl(String value)
```
    Parameters:
    
    value - The canonical URL that identifies the structure.
  - getModeElement
```
public Enumeration<StructureMap.StructureMapModelMode> getModeElement()
```
    Returns:
    
    mode (How the referenced structure is used in this mapping.). This is the underlying object with id, value and extensions. The accessor "getMode" gives direct access to the value
  - hasModeElement
```
public boolean hasModeElement()
```
  - hasMode
```
public boolean hasMode()
```
  - setModeElement
```
public StructureMap.StructureMapStructureComponent setModeElement(Enumeration<StructureMap.StructureMapModelMode> value)
```
    Parameters:
    
    value - mode (How the referenced structure is used in this mapping.). This is the underlying object with id, value and extensions. The accessor "getMode" gives direct access to the value
  - getMode
```
public StructureMap.StructureMapModelMode getMode()
```
    Returns:
    
    How the referenced structure is used in this mapping.
  - setMode
```
public StructureMap.StructureMapStructureComponent setMode(StructureMap.StructureMapModelMode value)
```
    Parameters:
    
    value - How the referenced structure is used in this mapping.
  - getAliasElement
```
public StringType getAliasElement()
```
    Returns:
    
    alias (The name used for this type in the map.). This is the underlying object with id, value and extensions. The accessor "getAlias" gives direct access to the value
  - hasAliasElement
```
public boolean hasAliasElement()
```
  - hasAlias
```
public boolean hasAlias()
```
  - setAliasElement
```
public StructureMap.StructureMapStructureComponent setAliasElement(StringType value)
```
    Parameters:
    
    value - alias (The name used for this type in the map.). This is the underlying object with id, value and extensions. The accessor "getAlias" gives direct access to the value
  - getAlias
```
public String getAlias()
```
    Returns:
    
    The name used for this type in the map.
  - setAlias
```
public StructureMap.StructureMapStructureComponent setAlias(String value)
```
    Parameters:
    
    value - The name used for this type in the map.
  - getDocumentationElement
```
public StringType getDocumentationElement()
```
    Returns:
    
    documentation (Documentation that describes how the structure is used in the mapping.). This is the underlying object with id, value and extensions. The accessor "getDocumentation" gives direct access to the value
  - hasDocumentationElement
```
public boolean hasDocumentationElement()
```
  - hasDocumentation
```
public boolean hasDocumentation()
```
  - setDocumentationElement
```
public StructureMap.StructureMapStructureComponent setDocumentationElement(StringType value)
```
    Parameters:
    
    value - documentation (Documentation that describes how the structure is used in the mapping.). This is the underlying object with id, value and extensions. The accessor "getDocumentation" gives direct access to the value
  - getDocumentation
```
public String getDocumentation()
```
    Returns:
    
    Documentation that describes how the structure is used in the mapping.
  - setDocumentation
```
public StructureMap.StructureMapStructureComponent setDocumentation(String value)
```
    Parameters:
    
    value - Documentation that describes how the structure is used in the mapping.
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class BackboneElement
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException
```
    Overrides:
    
    getProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws FHIRException
```
    Overrides:
    
    makeProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException
```
    Overrides:
    
    getTypesForProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - addChild
```
public Base addChild(String name)
              throws FHIRException
```
    Overrides:
    
    addChild in class BackboneElement
    
    Throws:
    
    FHIRException
  - copy
```
public StructureMap.StructureMapStructureComponent copy()
```
    Specified by:
    
    copy in class BackboneElement
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class BackboneElement
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class BackboneElement
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
    
    Overrides:
    
    isEmpty in class BackboneElement
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class BackboneElement

Class StructureMap.StructureMapStructureComponent

Field Summary

Fields inherited from class org.hl7.fhir.dstu3.model.BackboneElement

Fields inherited from class org.hl7.fhir.dstu3.model.Element

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu3.model.BackboneElement

Methods inherited from class org.hl7.fhir.dstu3.model.Element

Methods inherited from class org.hl7.fhir.dstu3.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Field Detail

url

mode

alias

documentation

Constructor Detail

StructureMapStructureComponent

StructureMapStructureComponent

Method Detail

getUrlElement

hasUrlElement

hasUrl

setUrlElement

getUrl

setUrl

getModeElement

hasModeElement

hasMode

setModeElement

getMode

setMode

getAliasElement

hasAliasElement

hasAlias

setAliasElement

getAlias

setAlias

getDocumentationElement

hasDocumentationElement

hasDocumentation

setDocumentationElement

getDocumentation

setDocumentation

listChildren

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

copy

equalsDeep

equalsShallow

isEmpty

fhirType