c

amf.plugins.domain.shapes.models

DataArrangementShape

abstract class DataArrangementShape extends AnyShape

Array shape

Linear Supertypes
AnyShape, InheritanceChain, ExternalSourceElement, DynamicDomainElement, JsonSchemaSerializer, ShapeHelpers, JsonSchemaSecrets, Shape, NamedDomainElement, Linkable, DomainElement, AmfObject, AmfElement, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DataArrangementShape
  2. AnyShape
  3. InheritanceChain
  4. ExternalSourceElement
  5. DynamicDomainElement
  6. JsonSchemaSerializer
  7. ShapeHelpers
  8. JsonSchemaSecrets
  9. Shape
  10. NamedDomainElement
  11. Linkable
  12. DomainElement
  13. AmfObject
  14. AmfElement
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DataArrangementShape(fields: Fields, annotations: Annotations)

Type Members

  1. type FacetsMap = Map[String, PropertyShape]
    Definition Classes
    Shape

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def add(field: Field, value: AmfElement): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  5. def add(other: Annotations): DataArrangementShape.this.type
    Definition Classes
    AmfElement
  6. def add(annotation: Annotation): DataArrangementShape.this.type
    Definition Classes
    AmfElement
  7. def addSubType(shape: Shape): Unit
    Definition Classes
    InheritanceChain
  8. def addSuperType(shape: Shape): Unit
    Definition Classes
    InheritanceChain
  9. def adopted(parent: String): DataArrangementShape.this.type
    Definition Classes
    DataArrangementShape → AmfObject
  10. def afterResolve(fatherSyntaxKey: Option[String], resolvedId: String): Unit
    Definition Classes
    Linkable
  11. def and: Seq[Shape]
    Definition Classes
    Shape
  12. val annotations: Annotations
    Definition Classes
    AnyShape → ExternalSourceElement → AmfElement
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def buildFixPoint(id: Option[String], name: String, link: Linkable, recursionErrorHandler: Option[ErrorHandler]): RecursiveShape
    Attributes
    protected
    Definition Classes
    ShapeHelpers
  15. def buildJsonSchema(): String
    Definition Classes
    AnyShape
  16. def classConstructor: (Fields, Annotations) ⇒ Linkable with DomainElement

    apply method for create a new instance with fields and annotations.

    apply method for create a new instance with fields and annotations. Aux method for copy

    Attributes
    protected
    Definition Classes
    AnyShape → Linkable
  17. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  18. def cloneShape(recursionErrorHandler: Option[ErrorHandler], withRecursionBase: Option[String] = None, traversed: IdsTraversionCheck = IdsTraversionCheck()): DataArrangementShape.this.type
    Definition Classes
    ShapeHelpers
  19. val closureShapes: Set[Shape]
    Definition Classes
    Shape
  20. def collectCustomShapePropertyDefinitions(onlyInherited: Boolean, traversed: Set[String]): Seq[FacetsMap]
    Definition Classes
    Shape
  21. def collectionFormat: String
  22. def componentId: String

    Value , path + field value that is used to compose the id when the object its adopted

    Value , path + field value that is used to compose the id when the object its adopted

    Definition Classes
    DataArrangementShapeAnyShape → AmfObject
  23. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  24. def copyAnyShape(fields: Fields = fields, annotations: Annotations = annotations): AnyShape
    Definition Classes
    AnyShape
  25. def copyElement(): Linkable with DomainElement
    Definition Classes
    Linkable
  26. def copyFields(recursionErrorHandler: Option[ErrorHandler], cloned: Shape, recursionBase: Option[String], traversed: IdsTraversionCheck): Unit
    Attributes
    protected
    Definition Classes
    Shape
  27. def copyShape(): DataArrangementShape.this.type
    Definition Classes
    AnyShape → Shape
  28. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement
  29. def customShapeProperties: Seq[ShapeExtension]
    Definition Classes
    Shape
  30. def customShapePropertyDefinitions: Seq[PropertyShape]
    Definition Classes
    Shape
  31. def default: DataNode
    Definition Classes
    Shape
  32. def defaultString: StrField
    Definition Classes
    Shape
  33. def description: StrField
    Definition Classes
    Shape
  34. def displayName: StrField
    Definition Classes
    Shape
  35. def documentation: CreativeWork
    Definition Classes
    AnyShape
  36. def dynamicFields: List[Field]
    Definition Classes
    ExternalSourceElement → DynamicDomainElement
  37. def dynamicType: List[ValueType]
    Definition Classes
    ExternalSourceElement → DynamicDomainElement
  38. def dynamicTypes(): Seq[String]
    Definition Classes
    DynamicDomainElement → AmfObject
  39. def effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  40. def effectiveLinkTarget: DomainElement
    Definition Classes
    Linkable
  41. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  42. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  43. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  44. def examples: Seq[Example]
    Definition Classes
    AnyShape
  45. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  46. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  47. val fields: Fields
    Definition Classes
    AnyShape → ExternalSourceElement → AmfObject
  48. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  49. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  50. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  51. def fromTypeExpression: Boolean
    Definition Classes
    ShapeHelpers
  52. def generateJsonSchema(element: AnyShape): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  53. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  54. lazy val graph: Graph
    Definition Classes
    DomainElement
  55. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  56. val id: String
    Definition Classes
    AmfObject
  57. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  58. def inherits: Seq[Shape]
    Definition Classes
    Shape
  59. def inlined: Boolean
    Attributes
    protected
    Definition Classes
    AnyShape
  60. def isDefaultEmpty: Boolean

    Aux method to know when the shape is instance only of any shape and it's because was parsed from an empty (or only with example) payload, an not an explicit type def

    Aux method to know when the shape is instance only of any shape and it's because was parsed from an empty (or only with example) payload, an not an explicit type def

    Definition Classes
    AnyShape
  61. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  62. def isLink: Boolean
    Definition Classes
    Linkable
  63. def isTrackedBy(trackId: String): Boolean
    Definition Classes
    AmfElement
  64. val isUnresolved: Boolean
    Definition Classes
    Linkable
  65. def link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  66. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  67. def linkCopy(): AnyShape
    Definition Classes
    AnyShape → Linkable
  68. def linkLabel: StrField
    Definition Classes
    Linkable
  69. def linkSubType(shape: AnyShape): Unit
    Definition Classes
    InheritanceChain
  70. def linkTarget: Option[DomainElement]
    Definition Classes
    Linkable
  71. def location(): Option[String]
    Definition Classes
    ExternalSourceElement → AmfElement
  72. def maxItems: IntField
  73. def meta: AnyShapeModel
    Definition Classes
    AnyShape → DomainElement
  74. def minItems: IntField
  75. def name: StrField
    Definition Classes
    Shape → NamedDomainElement
  76. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  77. def not: Shape
    Definition Classes
    Shape
  78. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  79. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  80. def or: Seq[Shape]
    Definition Classes
    Shape
  81. def parameterValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  82. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  83. def payloadValidator(shape: Shape, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  84. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  85. def ramlSyntaxKey: String
    Definition Classes
    DataArrangementShapeAnyShape → Shape
  86. def raw: StrField
    Definition Classes
    ExternalSourceElement
  87. val refAst: Option[YPart]
    Definition Classes
    Linkable
  88. val refCtx: Option[ParserContext]
    Definition Classes
    Linkable
  89. val refName: String
    Definition Classes
    Linkable
  90. def referenceId: StrField
    Definition Classes
    ExternalSourceElement
  91. def resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  92. def set(field: Field, value: AmfElement, annotations: Annotations): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  93. def set(field: Field, value: AmfElement): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  94. def set(field: Field, values: Seq[String]): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  95. def set(field: Field, value: Float): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  96. def set(field: Field, value: Double): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  97. def set(field: Field, value: Int): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  98. def set(field: Field, value: Boolean): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  99. def set(field: Field, value: String): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  100. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  101. def setArray(field: Field, values: Seq[AmfElement]): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  102. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  103. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  104. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  105. final def simpleAdoption(parent: String): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  106. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  107. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  108. def supportsInheritance: Boolean
    Definition Classes
    InheritanceChain
  109. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  110. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  111. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  112. def toJsonSchema: String
    Definition Classes
    AnyShape
  113. def toJsonSchema(element: AnyShape): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  114. def toString(): String
    Definition Classes
    AnyRef → Any
  115. def trackedExample(trackId: String): Option[Example]
    Definition Classes
    AnyShape
  116. def typeExpression: String
    Definition Classes
    ShapeHelpers
  117. def uniqueItems: BoolField
  118. def unresolved(refName: String, refAst: YPart, unresolvedSeverity: String)(implicit ctx: ParserContext): DomainElement with Linkable
    Definition Classes
    Linkable
  119. val unresolvedSeverity: String
    Definition Classes
    Linkable
  120. def validate(fragment: PayloadFragment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  121. def validate(fragment: PayloadFragment, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  122. def validate(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  123. def validate(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  124. def validateParameter(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  125. def validateParameter(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  126. def valueForField(f: Field): Option[Value]
    Definition Classes
    ExternalSourceElement → DynamicDomainElement
  127. def values: Seq[DataNode]
    Definition Classes
    Shape
  128. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  129. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  130. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  131. def withAnd(subShapes: Seq[Shape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  132. def withArrayItems(): ArrayShape
  133. def withCollectionFormat(collectionFormat: Boolean): DataArrangementShape.this.type
  134. def withCustomDomainProperties(extensions: Seq[DomainExtension]): DataArrangementShape.this.type
    Definition Classes
    DomainElement
  135. def withCustomDomainProperty(extensions: DomainExtension): DataArrangementShape.this.type
    Definition Classes
    DomainElement
  136. def withCustomShapeProperties(properties: Seq[ShapeExtension]): DataArrangementShape.this.type
    Definition Classes
    Shape
  137. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  138. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  139. def withDefault(default: DataNode): DataArrangementShape.this.type
    Definition Classes
    Shape
  140. def withDefaultStr(value: String): DataArrangementShape.this.type
    Definition Classes
    Shape
  141. def withDescription(description: String): DataArrangementShape.this.type
    Definition Classes
    Shape
  142. def withDisplayName(name: String): DataArrangementShape.this.type
    Definition Classes
    Shape
  143. def withDocumentation(documentation: CreativeWork): DataArrangementShape.this.type
    Definition Classes
    AnyShape
  144. def withExample(name: Option[String]): Example
    Definition Classes
    AnyShape
  145. def withExamples(examples: Seq[Example]): DataArrangementShape.this.type
    Definition Classes
    AnyShape
  146. def withExtends(extend: Seq[DomainElement]): DataArrangementShape.this.type
    Definition Classes
    DomainElement
  147. def withId(value: String): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  148. def withInherits(inherits: Seq[Shape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  149. def withLinkLabel(label: String): DataArrangementShape.this.type
    Definition Classes
    Linkable
  150. def withLinkTarget(target: DomainElement): DataArrangementShape.this.type
    Definition Classes
    Linkable
  151. def withMaxItems(maxItems: Int): DataArrangementShape.this.type
  152. def withMinItems(minItems: Int): DataArrangementShape.this.type
  153. def withName(name: String): DataArrangementShape.this.type
    Definition Classes
    Shape → NamedDomainElement
  154. def withNodeItems(): NodeShape
  155. def withNot(shape: Shape): DataArrangementShape.this.type
    Definition Classes
    Shape
  156. def withOr(subShapes: Seq[Shape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  157. def withReference(id: String): DataArrangementShape.this.type
    Definition Classes
    ExternalSourceElement
  158. def withScalarItems(): ScalarShape
  159. def withSupportsRecursion(recursive: Boolean): DataArrangementShape.this.type
    Definition Classes
    Linkable
  160. def withUniqueItems(uniqueItems: Boolean): DataArrangementShape.this.type
  161. def withValues(values: Seq[String]): DataArrangementShape.this.type
    Definition Classes
    Shape
  162. def withXMLSerialization(xmlSerialization: XMLSerializer): DataArrangementShape.this.type
    Definition Classes
    AnyShape
  163. def withXone(subShapes: Seq[Shape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  164. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  165. def xone: Seq[Shape]
    Definition Classes
    Shape

Inherited from AnyShape

Inherited from InheritanceChain

Inherited from ExternalSourceElement

Inherited from DynamicDomainElement

Inherited from JsonSchemaSerializer

Inherited from ShapeHelpers

Inherited from JsonSchemaSecrets

Inherited from Shape

Inherited from NamedDomainElement

Inherited from Linkable

Inherited from DomainElement

Inherited from AmfObject

Inherited from AmfElement

Inherited from AnyRef

Inherited from Any

Ungrouped