c

amf.plugins.domain.shapes.models

DataArrangementShape

abstract class DataArrangementShape extends AnyShape

Array shape

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

Inherited from AnyShape

Inherited from ExemplifiedDomainElement

Inherited from DocumentedElement

Inherited from InheritanceChain

Inherited from ExternalSourceElement

Inherited from RamlDatatypeSerializer

Inherited from JsonSchemaSerializer

Inherited from PlatformSecrets

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