c

amf.plugins.domain.shapes.models

DataArrangementShape

abstract class DataArrangementShape extends AnyShape

Array shape

Linear Supertypes
AnyShape, InheritanceChain, ExternalSourceElement, DynamicDomainElement, RamlDatatypeSerializer, 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. RamlDatatypeSerializer
  7. JsonSchemaSerializer
  8. ShapeHelpers
  9. JsonSchemaSecrets
  10. Shape
  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 → 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 buildRamlDatatype(): String

    Generates a new RAML Data Type.

    Generates a new RAML Data Type.

    Definition Classes
    AnyShape
  17. 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
  18. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  19. def cloneAllExamples(cloned: Shape, s: Shape): Unit
    Definition Classes
    ShapeHelpers
  20. def cloneShape(recursionErrorHandler: Option[ErrorHandler], withRecursionBase: Option[String] = None, traversed: IdsTraversionCheck = IdsTraversionCheck(), cloneExamples: Boolean = false): DataArrangementShape.this.type
    Definition Classes
    ShapeHelpers
  21. val closureShapes: Set[Shape]
    Definition Classes
    Shape
  22. def collectCustomShapePropertyDefinitions(onlyInherited: Boolean, traversed: Set[String]): Seq[FacetsMap]
    Definition Classes
    Shape
  23. def collectionFormat: String
  24. 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
  25. def computeSubtypesClosure(): Seq[Shape]
    Attributes
    protected
    Definition Classes
    InheritanceChain
  26. def copyAnyShape(fields: Fields = fields, annotations: Annotations = annotations): AnyShape
    Definition Classes
    AnyShape
  27. def copyElement(a: Annotations): Linkable with DomainElement
    Definition Classes
    Linkable
  28. def copyElement(): Linkable with DomainElement
    Definition Classes
    Linkable
  29. def copyFields(recursionErrorHandler: Option[ErrorHandler], cloned: Shape, recursionBase: Option[String], traversed: IdsTraversionCheck): Unit
    Attributes
    protected
    Definition Classes
    Shape
  30. def copyShape(): DataArrangementShape.this.type
    Definition Classes
    AnyShape → Shape
  31. def copyShape(a: Annotations): DataArrangementShape.this.type
    Definition Classes
    Shape
  32. def customDomainProperties: Seq[DomainExtension]
    Definition Classes
    DomainElement
  33. def customShapeProperties: Seq[ShapeExtension]
    Definition Classes
    Shape
  34. def customShapePropertyDefinitions: Seq[PropertyShape]
    Definition Classes
    Shape
  35. def default: DataNode
    Definition Classes
    Shape
  36. def defaultString: StrField
    Definition Classes
    Shape
  37. def description: StrField
    Definition Classes
    Shape
  38. def displayName: StrField
    Definition Classes
    Shape
  39. def documentation: CreativeWork
    Definition Classes
    AnyShape
  40. def effectiveInherits: Seq[Shape]
    Definition Classes
    Shape
  41. def effectiveLinkTarget(links: Seq[String]): DomainElement
    Definition Classes
    Linkable
  42. def effectiveStructuralShapes: Seq[Shape]
    Definition Classes
    InheritanceChain
  43. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  44. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  45. def examples: Seq[Example]
    Definition Classes
    AnyShape
  46. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  47. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  48. val fields: Fields
    Definition Classes
    AnyShape → ExternalSourceElement → AmfObject
  49. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  50. def fromExternalSource: Boolean
    Definition Classes
    ShapeHelpers
  51. def fromLocal(): Boolean
    Definition Classes
    AmfElement
  52. def fromTypeExpression: Boolean
    Definition Classes
    ShapeHelpers
  53. def generateJsonSchema(element: AnyShape): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  54. 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
  55. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  56. lazy val graph: Graph
    Definition Classes
    DomainElement
  57. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  58. val id: String
    Definition Classes
    AmfObject
  59. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  60. def inherits: Seq[Shape]
    Definition Classes
    Shape
  61. def inlined: Boolean
    Attributes
    protected
    Definition Classes
    AnyShape
  62. 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
  63. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  64. def isLink: Boolean
    Definition Classes
    Linkable
  65. def isTrackedBy(trackId: String): Boolean
    Definition Classes
    AmfElement
  66. val isUnresolved: Boolean
    Definition Classes
    Linkable
  67. def link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  68. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  69. def linkCopy(): AnyShape
    Definition Classes
    AnyShape → Linkable
  70. def linkLabel: StrField
    Definition Classes
    Linkable
  71. def linkSubType(shape: AnyShape): Unit
    Definition Classes
    InheritanceChain
  72. def linkTarget: Option[DomainElement]
    Definition Classes
    Linkable
  73. def location(): Option[String]
    Definition Classes
    ExternalSourceElement → AmfElement
  74. def maxItems: IntField
  75. val meta: AnyShapeModel
    Definition Classes
    AnyShape → AmfObject
  76. def minItems: IntField
  77. def name: StrField
    Definition Classes
    NamedDomainElement
  78. def nameField: Field
    Attributes
    protected
    Definition Classes
    Shape → NamedDomainElement
  79. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  80. def not: Shape
    Definition Classes
    Shape
  81. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  82. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  83. def or: Seq[Shape]
    Definition Classes
    Shape
  84. def parameterValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  85. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  86. def payloadValidator(shape: Shape, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  87. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  88. def ramlSyntaxKey: String
    Definition Classes
    DataArrangementShapeAnyShape → Shape
  89. def raw: StrField
    Definition Classes
    ExternalSourceElement
  90. val refAst: Option[YPart]
    Definition Classes
    Linkable
  91. val refCtx: Option[ParserContext]
    Definition Classes
    Linkable
  92. val refName: String
    Definition Classes
    Linkable
  93. def referenceId: StrField
    Definition Classes
    ExternalSourceElement
  94. def resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  95. def set(field: Field, value: AmfElement, annotations: Annotations): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  96. def set(field: Field, value: AmfElement): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  97. def set(field: Field, values: Seq[String]): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  98. def set(field: Field, value: Float): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  99. def set(field: Field, value: Double): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  100. def set(field: Field, value: Int): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  101. def set(field: Field, value: Boolean): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  102. def set(field: Field, value: String): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  103. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  104. def setArray(field: Field, values: Seq[AmfElement]): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  105. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  106. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  107. val shouldLink: Boolean
    Attributes
    protected
    Definition Classes
    Linkable
  108. final def simpleAdoption(parent: String): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  109. val subTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  110. val superTypes: Seq[Shape]
    Definition Classes
    InheritanceChain
  111. def supportsInheritance: Boolean
    Definition Classes
    InheritanceChain
  112. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  113. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  114. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  115. def toJsonSchema: String
    Definition Classes
    AnyShape
  116. def toJsonSchema(element: AnyShape): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  117. 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
  118. 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
  119. def toString(): String
    Definition Classes
    AnyRef → Any
  120. def trackedExample(trackId: String): Option[Example]
    Definition Classes
    AnyShape
  121. def typeExpression(eh: ErrorHandler): String
    Definition Classes
    ShapeHelpers
  122. def uniqueItems: BoolField
  123. def unresolved(refName: String, refAst: YPart, unresolvedSeverity: String)(implicit ctx: ParserContext): DomainElement with Linkable
    Definition Classes
    Linkable
  124. val unresolvedSeverity: String
    Definition Classes
    Linkable
  125. def validate(fragment: PayloadFragment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  126. def validate(fragment: PayloadFragment, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  127. def validate(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  128. def validate(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  129. def validateParameter(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  130. def validateParameter(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  131. def valueForField(f: Field): Option[Value]
    Definition Classes
    ExternalSourceElement → DynamicDomainElement
  132. def values: Seq[DataNode]
    Definition Classes
    Shape
  133. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  134. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  135. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  136. def withAnd(subShapes: Seq[Shape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  137. def withArrayItems(): ArrayShape
  138. def withCollectionFormat(collectionFormat: Boolean): DataArrangementShape.this.type
  139. def withCustomDomainProperties(extensions: Seq[DomainExtension]): DataArrangementShape.this.type
    Definition Classes
    DomainElement
  140. def withCustomDomainProperty(extensions: DomainExtension): DataArrangementShape.this.type
    Definition Classes
    DomainElement
  141. def withCustomShapeProperties(properties: Seq[ShapeExtension]): DataArrangementShape.this.type
    Definition Classes
    Shape
  142. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  143. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  144. def withDefault(default: DataNode): DataArrangementShape.this.type
    Definition Classes
    Shape
  145. def withDefaultStr(value: String): DataArrangementShape.this.type
    Definition Classes
    Shape
  146. def withDescription(description: String): DataArrangementShape.this.type
    Definition Classes
    Shape
  147. def withDisplayName(name: String): DataArrangementShape.this.type
    Definition Classes
    Shape
  148. def withDocumentation(documentation: CreativeWork): DataArrangementShape.this.type
    Definition Classes
    AnyShape
  149. def withExample(name: Option[String]): Example
    Definition Classes
    AnyShape
  150. def withExamples(examples: Seq[Example]): DataArrangementShape.this.type
    Definition Classes
    AnyShape
  151. def withExtends(extend: Seq[DomainElement]): DataArrangementShape.this.type
    Definition Classes
    DomainElement
  152. def withId(value: String): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  153. def withInherits(inherits: Seq[Shape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  154. def withLinkLabel(label: String): DataArrangementShape.this.type
    Definition Classes
    Linkable
  155. def withLinkTarget(target: DomainElement): DataArrangementShape.this.type
    Definition Classes
    Linkable
  156. def withMaxItems(maxItems: Int): DataArrangementShape.this.type
  157. def withMinItems(minItems: Int): DataArrangementShape.this.type
  158. def withName(name: String, a: Annotations): DataArrangementShape.this.type
    Definition Classes
    NamedDomainElement
  159. def withNodeItems(): NodeShape
  160. def withNot(shape: Shape): DataArrangementShape.this.type
    Definition Classes
    Shape
  161. def withOr(subShapes: Seq[Shape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  162. def withReference(id: String): DataArrangementShape.this.type
    Definition Classes
    ExternalSourceElement
  163. def withScalarItems(): ScalarShape
  164. def withSupportsRecursion(recursive: Boolean): DataArrangementShape.this.type
    Definition Classes
    Linkable
  165. def withUniqueItems(uniqueItems: Boolean): DataArrangementShape.this.type
  166. def withValues(values: Seq[DataNode]): DataArrangementShape.this.type
    Definition Classes
    Shape
  167. def withXMLSerialization(xmlSerialization: XMLSerializer): DataArrangementShape.this.type
    Definition Classes
    AnyShape
  168. def withXone(subShapes: Seq[Shape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  169. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  170. def xone: Seq[Shape]
    Definition Classes
    Shape

Inherited from AnyShape

Inherited from InheritanceChain

Inherited from ExternalSourceElement

Inherited from DynamicDomainElement

Inherited from RamlDatatypeSerializer

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