c

amf.plugins.domain.shapes.models

DataArrangementShape

abstract class DataArrangementShape extends AnyShape

Array shape

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

Inherited from AnyShape

Inherited from ValidatorAware

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 CustomizableElement

Inherited from AmfObject

Inherited from AmfElement

Inherited from AnyRef

Inherited from Any

Ungrouped