c

amf.plugins.domain.shapes.models

DataArrangementShape

abstract class DataArrangementShape extends AnyShape

Array shape

Linear Supertypes
AnyShape, InheritanceChain, ExternalSourceElement, RamlDatatypeSerializer, JsonSchemaSerializer, ShapeHelpers, JsonSchemaSecrets, Shape, ShapeHelper, 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. RamlDatatypeSerializer
  6. JsonSchemaSerializer
  7. ShapeHelpers
  8. JsonSchemaSecrets
  9. Shape
  10. ShapeHelper
  11. NamedDomainElement
  12. Linkable
  13. DomainElement
  14. AmfObject
  15. AmfElement
  16. AnyRef
  17. 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, cycle: Seq[String] = Seq()): 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 → 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(options: ShapeRenderOptions): String
    Definition Classes
    AnyShape
  16. def buildJsonSchema(): String
    Definition Classes
    AnyShape
  17. def buildRamlDatatype(): String

    Generates a new RAML Data Type.

    Generates a new RAML Data Type.

    Definition Classes
    AnyShape
  18. 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
  19. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  20. def cloneAllExamples(cloned: Shape, s: Shape): Unit
    Definition Classes
    ShapeHelpers
  21. def cloneShape(recursionErrorHandler: Option[ErrorHandler], withRecursionBase: Option[String] = None, traversal: ModelTraversalRegistry = ModelTraversalRegistry(), cloneExamples: Boolean = false): DataArrangementShape.this.type
    Definition Classes
    ShapeHelpers
  22. val closureShapes: Set[Shape]
    Definition Classes
    Shape
  23. def collectCustomShapePropertyDefinitions(onlyInherited: Boolean, traversed: Set[String]): Seq[FacetsMap]
    Definition Classes
    Shape
  24. def collectionFormat: String
  25. 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
  26. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  27. def copyAnyShape(fields: Fields = fields, annotations: Annotations = annotations): AnyShape
    Definition Classes
    AnyShape
  28. def copyElement(a: Annotations): Linkable with DomainElement
    Definition Classes
    Linkable
  29. def copyElement(): Linkable with DomainElement
    Definition Classes
    Linkable
  30. def copyFields(recursionErrorHandler: Option[ErrorHandler], cloned: Shape, recursionBase: Option[String], traversal: ModelTraversalRegistry): Unit
    Attributes
    protected
    Definition Classes
    Shape
  31. def copyShape(): DataArrangementShape.this.type
    Definition Classes
    AnyShape → Shape
  32. def copyShape(a: Annotations): DataArrangementShape.this.type
    Definition Classes
    Shape
  33. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement
  34. def customShapeProperties: Seq[ShapeExtension]
    Definition Classes
    Shape
  35. def customShapePropertyDefinitions: Seq[PropertyShape]
    Definition Classes
    Shape
  36. def default: DataNode
    Definition Classes
    Shape
  37. def defaultString: StrField
    Definition Classes
    Shape
  38. def description: StrField
    Definition Classes
    Shape
  39. def displayName: StrField
    Definition Classes
    Shape
  40. def documentation: CreativeWork
    Definition Classes
    AnyShape
  41. def effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  42. def effectiveLinkTarget(links: Seq[String]): DomainElement
    Definition Classes
    Linkable
  43. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  44. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  46. def examples: Seq[Example]
    Definition Classes
    AnyShape
  47. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  48. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  49. val fields: Fields
    Definition Classes
    AnyShape → AmfObject
  50. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  51. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  52. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  53. def fromTypeExpression: Boolean
    Definition Classes
    ShapeHelpers
  54. def generateJsonSchema(element: AnyShape, options: ShapeRenderOptions = ShapeRenderOptions()): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  55. def generateRamlDatatype(element: AnyShape): String

    Generates a new RAML Data Type included in RAML 1.0 Library.

    Generates a new RAML Data Type included in RAML 1.0 Library.

    Attributes
    protected
    Definition Classes
    RamlDatatypeSerializer
  56. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  57. lazy val graph: Graph
    Definition Classes
    DomainElement
  58. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  59. val id: String
    Definition Classes
    AmfObject
  60. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  61. def inherits: Seq[Shape]
    Definition Classes
    Shape
  62. def inlined: Boolean
    Definition Classes
    AnyShape
  63. 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
  64. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  65. def isLink: Boolean
    Definition Classes
    Linkable
  66. def isLinkToSource: Boolean
    Definition Classes
    ExternalSourceElement
  67. def isTrackedBy(trackId: String): Boolean
    Definition Classes
    AmfElement
  68. val isUnresolved: Boolean
    Definition Classes
    Linkable
  69. def link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  70. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  71. def linkCopy(): AnyShape
    Definition Classes
    AnyShape → Linkable
  72. def linkLabel: StrField
    Definition Classes
    Linkable
  73. def linkSubType(shape: AnyShape): Unit
    Definition Classes
    InheritanceChain
  74. def linkTarget: Option[DomainElement]
    Definition Classes
    Linkable
  75. def location(): Option[String]
    Definition Classes
    ExternalSourceElement → AmfElement
  76. def maxItems: IntField
  77. def meta: AnyShapeModel
    Definition Classes
    AnyShape → AmfObject
  78. def minItems: IntField
  79. def name: StrField
    Definition Classes
    NamedDomainElement
  80. def nameField: Field
    Attributes
    protected
    Definition Classes
    Shape → NamedDomainElement
  81. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  82. def not: Shape
    Definition Classes
    Shape
  83. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  84. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  85. def or: Seq[Shape]
    Definition Classes
    Shape
  86. def parameterValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  87. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  88. def payloadValidator(shape: Shape, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  89. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  90. def ramlSyntaxKey: String
    Definition Classes
    DataArrangementShapeAnyShape → Shape
  91. def raw: StrField
    Definition Classes
    ExternalSourceElement
  92. val refAst: Option[YPart]
    Definition Classes
    Linkable
  93. val refCtx: Option[ParserContext]
    Definition Classes
    Linkable
  94. val refName: String
    Definition Classes
    Linkable
  95. def referenceId: StrField
    Definition Classes
    ExternalSourceElement
  96. def resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  97. def set(field: Field, value: AmfElement, annotations: Annotations): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  98. def set(field: Field, value: AmfElement): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  99. def set(field: Field, values: Seq[String]): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  100. def set(field: Field, value: Float): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  101. def set(field: Field, value: Double): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  102. def set(field: Field, value: Int): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  103. def set(field: Field, value: Boolean): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  104. def set(field: Field, value: String): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  105. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  106. def setArray(field: Field, values: Seq[AmfElement]): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  107. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  108. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  109. def setDefaultStrValue(entry: YMapEntry): Unit
    Definition Classes
    ShapeHelper
  110. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  111. final def simpleAdoption(parent: String): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  112. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  113. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  114. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  115. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  116. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  117. def toJsonSchema: String
    Definition Classes
    AnyShape
  118. def toJsonSchema(element: AnyShape): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  119. def toRamlDatatype: String

    Delegates generation of a new RAML Data Type or returns cached one if it was generated before.

    Delegates generation of a new RAML Data Type or returns cached one if it was generated before.

    Definition Classes
    AnyShape
  120. def toRamlDatatype(element: AnyShape): String

    Delegates generation of a new RAML Data Type or returns cached one if it was generated before.

    Delegates generation of a new RAML Data Type or returns cached one if it was generated before.

    Attributes
    protected
    Definition Classes
    RamlDatatypeSerializer
  121. def toString(): String
    Definition Classes
    AnyRef → Any
  122. def trackedExample(trackId: String): Option[Example]
    Definition Classes
    AnyShape
  123. def typeExpression(eh: ErrorHandler): String
    Definition Classes
    ShapeHelpers
  124. def uniqueItems: BoolField
  125. def unresolved(refName: String, refAst: YPart, unresolvedSeverity: String)(implicit ctx: ParserContext): DomainElement with Linkable
    Definition Classes
    Linkable
  126. val unresolvedSeverity: String
    Definition Classes
    Linkable
  127. def validate(fragment: PayloadFragment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  128. def validate(fragment: PayloadFragment, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  129. def validate(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  130. def validate(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  131. def validateParameter(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  132. def validateParameter(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  133. def values: Seq[DataNode]
    Definition Classes
    Shape
  134. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  135. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  136. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  137. def withAnd(subShapes: Seq[Shape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  138. def withArrayItems(): ArrayShape
  139. def withCollectionFormat(collectionFormat: Boolean): DataArrangementShape.this.type
  140. def withCustomDomainProperties(extensions: Seq[DomainExtension]): DataArrangementShape.this.type
    Definition Classes
    DomainElement
  141. def withCustomDomainProperty(extensions: DomainExtension): DataArrangementShape.this.type
    Definition Classes
    DomainElement
  142. def withCustomShapeProperties(properties: Seq[ShapeExtension]): DataArrangementShape.this.type
    Definition Classes
    Shape
  143. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  144. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  145. def withDefault(default: DataNode): DataArrangementShape.this.type
    Definition Classes
    Shape
  146. def withDefaultStr(value: String): DataArrangementShape.this.type
    Definition Classes
    Shape
  147. def withDescription(description: String): DataArrangementShape.this.type
    Definition Classes
    Shape
  148. def withDisplayName(name: String): DataArrangementShape.this.type
    Definition Classes
    Shape
  149. def withDocumentation(documentation: CreativeWork): DataArrangementShape.this.type
    Definition Classes
    AnyShape
  150. def withExample(name: Option[String]): Example
    Definition Classes
    AnyShape
  151. def withExamples(examples: Seq[Example]): DataArrangementShape.this.type
    Definition Classes
    AnyShape
  152. def withExtends(extend: Seq[DomainElement]): DataArrangementShape.this.type
    Definition Classes
    DomainElement
  153. def withId(value: String): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  154. def withInherits(inherits: Seq[Shape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  155. def withLinkLabel(label: String): DataArrangementShape.this.type
    Definition Classes
    Linkable
  156. def withLinkTarget(target: DomainElement): DataArrangementShape.this.type
    Definition Classes
    Linkable
  157. def withMaxItems(maxItems: Int): DataArrangementShape.this.type
  158. def withMinItems(minItems: Int): DataArrangementShape.this.type
  159. def withName(name: String, a: Annotations): DataArrangementShape.this.type
    Definition Classes
    NamedDomainElement
  160. def withNodeItems(): NodeShape
  161. def withNot(shape: Shape): DataArrangementShape.this.type
    Definition Classes
    Shape
  162. def withOr(subShapes: Seq[Shape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  163. def withReference(id: String): DataArrangementShape.this.type
    Definition Classes
    ExternalSourceElement
  164. def withScalarItems(): ScalarShape
  165. def withSupportsRecursion(recursive: Boolean): DataArrangementShape.this.type
    Definition Classes
    Linkable
  166. def withUniqueItems(uniqueItems: Boolean): DataArrangementShape.this.type
  167. def withValues(values: Seq[DataNode]): DataArrangementShape.this.type
    Definition Classes
    Shape
  168. def withXMLSerialization(xmlSerialization: XMLSerializer): DataArrangementShape.this.type
    Definition Classes
    AnyShape
  169. def withXone(subShapes: Seq[Shape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  170. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  171. def xone: Seq[Shape]
    Definition Classes
    Shape

Inherited from AnyShape

Inherited from InheritanceChain

Inherited from ExternalSourceElement

Inherited from RamlDatatypeSerializer

Inherited from JsonSchemaSerializer

Inherited from ShapeHelpers

Inherited from JsonSchemaSecrets

Inherited from Shape

Inherited from ShapeHelper

Inherited from NamedDomainElement

Inherited from Linkable

Inherited from DomainElement

Inherited from AmfObject

Inherited from AmfElement

Inherited from AnyRef

Inherited from Any

Ungrouped