Package com.ibm.fhir.model.resource

Class StructureMap.Structure

java.lang.Object

com.ibm.fhir.model.visitor.AbstractVisitable

com.ibm.fhir.model.type.Element

com.ibm.fhir.model.type.BackboneElement

com.ibm.fhir.model.resource.StructureMap.Structure

All Implemented Interfaces:

Visitable

Enclosing class:

StructureMap

public static class StructureMap.Structure
extends BackboneElement

A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StructureMap.Structure.Builder

Field Summary

Fields inherited from class com.ibm.fhir.model.type.BackboneElement

modifierExtension

Fields inherited from class com.ibm.fhir.model.type.Element

extension, hashCode, id

Method Summary

Modifier and Type	Method	Description
void	accept(java.lang.String elementName, int elementIndex, Visitor visitor)	Accept a Visitor and invoke the appropriate visit methods.
static StructureMap.Structure.Builder	builder()
boolean	equals(java.lang.Object obj)
String	getAlias()	The name used for this type in the map.
String	getDocumentation()	Documentation that describes how the structure is used in the mapping.
StructureMapModelMode	getMode()	How the referenced structure is used in this mapping.
Canonical	getUrl()	The canonical reference to the structure.
boolean	hasChildren()
int	hashCode()
StructureMap.Structure.Builder	toBuilder()	Create a new Builder from the contents of this Element

Methods inherited from class com.ibm.fhir.model.type.BackboneElement

getModifierExtension

Methods inherited from class com.ibm.fhir.model.type.Element

as, getExtension, getId, hasValue, is

Methods inherited from class com.ibm.fhir.model.visitor.AbstractVisitable

accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.fhir.model.visitor.Visitable

accept, accept

Method Detail

getUrl

public Canonical getUrl()

The canonical reference to the structure.

Returns:

An immutable object of type Canonical that is non-null.

getMode

public StructureMapModelMode getMode()

How the referenced structure is used in this mapping.

Returns:

An immutable object of type StructureMapModelMode that is non-null.

getAlias

public String getAlias()

The name used for this type in the map.

Returns:

An immutable object of type String that may be null.

getDocumentation

public String getDocumentation()

Documentation that describes how the structure is used in the mapping.

Returns:

An immutable object of type String that may be null.

hasChildren

public boolean hasChildren()

Overrides:

hasChildren in class BackboneElement

accept

public void accept(java.lang.String elementName,
                   int elementIndex,
                   Visitor visitor)

Description copied from interface: Visitable

Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:

 if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
 

Specified by:

accept in interface Visitable

Specified by:

accept in class AbstractVisitable

Parameters:

elementName - the name of the element in the context of this visit

elementIndex - the index of the element in a list or -1 if it is not contained within a List

visitor - the visitor to use

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toBuilder

public StructureMap.Structure.Builder toBuilder()

Description copied from class: Element

Create a new Builder from the contents of this Element

Specified by:

toBuilder in class BackboneElement

builder

public static StructureMap.Structure.Builder builder()