c

amf.plugins.domain.shapes.models

DataArrangementShape

abstract class DataArrangementShape extends AnyShape

Array shape

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

Inherited from AnyShape

Inherited from ExemplifiedDomainElement

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