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): 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 dynamicFields: List[Field]
    Definition Classes
    ExternalSourceElement → DynamicDomainElement
  41. def dynamicType: List[ValueType]
    Definition Classes
    ExternalSourceElement → DynamicDomainElement
  42. def dynamicTypes(): Seq[String]
    Definition Classes
    DynamicDomainElement → AmfObject
  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. 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
    AnyShape
  49. def extend: Seq[DomainElement]
    Definition Classes
    DomainElement
  50. def externalSourceID: Option[String]
    Definition Classes
    ShapeHelpers
  51. val fields: Fields
    Definition Classes
    AnyShape → ExternalSourceElement → AmfObject
  52. def finalize(): Unit
    Attributes
    protected[java.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): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  57. 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
  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. val inheritedIds: Seq[String]
    Definition Classes
    InheritanceChain
  63. def inherits: Seq[Shape]
    Definition Classes
    Shape
  64. def inlined: Boolean
    Attributes
    protected
    Definition Classes
    AnyShape
  65. 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
  66. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  67. def isLink: Boolean
    Definition Classes
    Linkable
  68. def isTrackedBy(trackId: String): Boolean
    Definition Classes
    AmfElement
  69. val isUnresolved: Boolean
    Definition Classes
    Linkable
  70. def link[T](label: String, annotations: Annotations): T
    Definition Classes
    Linkable
  71. val linkAnnotations: Option[Annotations]
    Definition Classes
    Linkable
  72. def linkCopy(): AnyShape
    Definition Classes
    AnyShape → Linkable
  73. def linkLabel: StrField
    Definition Classes
    Linkable
  74. def linkSubType(shape: AnyShape): Unit
    Definition Classes
    InheritanceChain
  75. def linkTarget: Option[DomainElement]
    Definition Classes
    Linkable
  76. def location(): Option[String]
    Definition Classes
    ExternalSourceElement → AmfElement
  77. def maxItems: IntField
  78. def meta: AnyShapeModel
    Definition Classes
    AnyShape → DomainElement
  79. def minItems: IntField
  80. def name: StrField
    Definition Classes
    NamedDomainElement
  81. def nameField: Field
    Attributes
    protected
    Definition Classes
    Shape → NamedDomainElement
  82. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  83. def not: Shape
    Definition Classes
    Shape
  84. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  85. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  86. def or: Seq[Shape]
    Definition Classes
    Shape
  87. def parameterValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  88. def payloadValidator(mediaType: String, env: Environment = Environment()): Option[PayloadValidator]
    Definition Classes
    AnyShape
  89. def payloadValidator(shape: Shape, validationMode: ValidationMode): PlatformPayloadValidator
    Attributes
    protected
    Definition Classes
    JsonSchemaSecrets
  90. def position(): Option[LexicalInformation]
    Definition Classes
    AmfElement
  91. def ramlSyntaxKey: String
    Definition Classes
    DataArrangementShapeAnyShape → Shape
  92. def raw: StrField
    Definition Classes
    ExternalSourceElement
  93. val refAst: Option[YPart]
    Definition Classes
    Linkable
  94. val refCtx: Option[ParserContext]
    Definition Classes
    Linkable
  95. val refName: String
    Definition Classes
    Linkable
  96. def referenceId: StrField
    Definition Classes
    ExternalSourceElement
  97. def resolveUnreferencedLink[T](label: String, annotations: Annotations, unresolved: T, supportsRecursion: Boolean): T
    Definition Classes
    Linkable
  98. def set(field: Field, value: AmfElement, annotations: Annotations): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  99. def set(field: Field, value: AmfElement): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  100. def set(field: Field, values: Seq[String]): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  101. def set(field: Field, value: Float): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  102. def set(field: Field, value: Double): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  103. def set(field: Field, value: Int): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  104. def set(field: Field, value: Boolean): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  105. def set(field: Field, value: String): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  106. def setArray(field: Field, values: Seq[AmfElement], annotations: Annotations): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  107. def setArray(field: Field, values: Seq[AmfElement]): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  108. def setArrayWithoutId(field: Field, values: Seq[AmfElement], annotations: Annotations): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  109. def setArrayWithoutId(field: Field, values: Seq[AmfElement]): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  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 supportsInheritance: Boolean
    Definition Classes
    InheritanceChain
  115. def supportsRecursion: BoolField
    Definition Classes
    Linkable
  116. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  117. def toFutureRef(resolve: (Linkable) ⇒ Unit): Unit
    Definition Classes
    Linkable
  118. def toJsonSchema: String
    Definition Classes
    AnyShape
  119. def toJsonSchema(element: AnyShape): String
    Attributes
    protected
    Definition Classes
    JsonSchemaSerializer
  120. 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
  121. 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
  122. def toString(): String
    Definition Classes
    AnyRef → Any
  123. def trackedExample(trackId: String): Option[Example]
    Definition Classes
    AnyShape
  124. def typeExpression(eh: ErrorHandler): String
    Definition Classes
    ShapeHelpers
  125. def uniqueItems: BoolField
  126. def unresolved(refName: String, refAst: YPart, unresolvedSeverity: String)(implicit ctx: ParserContext): DomainElement with Linkable
    Definition Classes
    Linkable
  127. val unresolvedSeverity: String
    Definition Classes
    Linkable
  128. def validate(fragment: PayloadFragment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  129. def validate(fragment: PayloadFragment, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  130. def validate(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  131. def validate(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  132. def validateParameter(payload: String): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  133. def validateParameter(payload: String, env: Environment): Future[AMFValidationReport]
    Definition Classes
    AnyShape
  134. def valueForField(f: Field): Option[Value]
    Definition Classes
    ExternalSourceElement → DynamicDomainElement
  135. def values: Seq[DataNode]
    Definition Classes
    Shape
  136. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  137. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  138. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  139. def withAnd(subShapes: Seq[Shape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  140. def withArrayItems(): ArrayShape
  141. def withCollectionFormat(collectionFormat: Boolean): DataArrangementShape.this.type
  142. def withCustomDomainProperties(extensions: Seq[DomainExtension]): DataArrangementShape.this.type
    Definition Classes
    DomainElement
  143. def withCustomDomainProperty(extensions: DomainExtension): DataArrangementShape.this.type
    Definition Classes
    DomainElement
  144. def withCustomShapeProperties(properties: Seq[ShapeExtension]): DataArrangementShape.this.type
    Definition Classes
    Shape
  145. def withCustomShapePropertyDefinition(name: String): PropertyShape
    Definition Classes
    Shape
  146. def withCustomShapePropertyDefinitions(propertyDefinitions: Seq[PropertyShape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  147. def withDefault(default: DataNode): DataArrangementShape.this.type
    Definition Classes
    Shape
  148. def withDefaultStr(value: String): DataArrangementShape.this.type
    Definition Classes
    Shape
  149. def withDescription(description: String): DataArrangementShape.this.type
    Definition Classes
    Shape
  150. def withDisplayName(name: String): DataArrangementShape.this.type
    Definition Classes
    Shape
  151. def withDocumentation(documentation: CreativeWork): DataArrangementShape.this.type
    Definition Classes
    AnyShape
  152. def withExample(name: Option[String]): Example
    Definition Classes
    AnyShape
  153. def withExamples(examples: Seq[Example]): DataArrangementShape.this.type
    Definition Classes
    AnyShape
  154. def withExtends(extend: Seq[DomainElement]): DataArrangementShape.this.type
    Definition Classes
    DomainElement
  155. def withId(value: String): DataArrangementShape.this.type
    Definition Classes
    AmfObject
  156. def withInherits(inherits: Seq[Shape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  157. def withLinkLabel(label: String): DataArrangementShape.this.type
    Definition Classes
    Linkable
  158. def withLinkTarget(target: DomainElement): DataArrangementShape.this.type
    Definition Classes
    Linkable
  159. def withMaxItems(maxItems: Int): DataArrangementShape.this.type
  160. def withMinItems(minItems: Int): DataArrangementShape.this.type
  161. def withName(name: String, a: Annotations): DataArrangementShape.this.type
    Definition Classes
    NamedDomainElement
  162. def withNodeItems(): NodeShape
  163. def withNot(shape: Shape): DataArrangementShape.this.type
    Definition Classes
    Shape
  164. def withOr(subShapes: Seq[Shape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  165. def withReference(id: String): DataArrangementShape.this.type
    Definition Classes
    ExternalSourceElement
  166. def withScalarItems(): ScalarShape
  167. def withSupportsRecursion(recursive: Boolean): DataArrangementShape.this.type
    Definition Classes
    Linkable
  168. def withUniqueItems(uniqueItems: Boolean): DataArrangementShape.this.type
  169. def withValues(values: Seq[DataNode]): DataArrangementShape.this.type
    Definition Classes
    Shape
  170. def withXMLSerialization(xmlSerialization: XMLSerializer): DataArrangementShape.this.type
    Definition Classes
    AnyShape
  171. def withXone(subShapes: Seq[Shape]): DataArrangementShape.this.type
    Definition Classes
    Shape
  172. def xmlSerialization: XMLSerializer
    Definition Classes
    AnyShape
  173. 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