Interface SchemaFacet
- All Known Subinterfaces:
SchemaFacetBoundary
,SchemaFacetBoundaryMaxExclusive
,SchemaFacetBoundaryMaxInclusive
,SchemaFacetBoundaryMinExclusive
,SchemaFacetBoundaryMinInclusive
,SchemaFacetEnumeration
,SchemaFacetExcludeSegment
,SchemaFacetExcludeValue
,SchemaFacetFractionDigits
,SchemaFacetLength
,SchemaFacetMaxLength
,SchemaFacetMinLength
,SchemaFacetOnLength
,SchemaFacetOnMandatoryField
,SchemaFacetPattern
,SchemaFacetTableRef
,SchemaFacetTotalDigits
public interface SchemaFacet
Common interface for constraints on data types
(also known as constraining facets in XML Schema).
-
Method Summary
Modifier and TypeMethodDescriptiongetDocumentation
(Locale aLocale, ValueContext aContext) Returns the end-user documentation for this facet.Returns the validation message defined in the data model.Returns the node associated to this facet.Returns the validation policy of this facet.boolean
Returnstrue
if this facet defines an enumeration of possible values.boolean
Returnstrue
if this facet defines a nomenclature.boolean
Returnstrue
if this facet is a foreign key constraint (osd:tableRef
).boolean
Returnstrue
if this facet is amaxExclusive
facet.boolean
Returnstrue
if this facet is amaxInclusive
facet.boolean
Returnstrue
if this facet is aminExclusive
facet.boolean
Returnstrue
if this facet is aminInclusive
facet.boolean
Returnstrue
if this facet defines either anenumeration
or anomenclature
.boolean
Returnstrue
if this facet is anexcludeSegment
facet.boolean
Returnstrue
if this facet is anexcludeValue
facet.boolean
Returnstrue
if this facet is afractionDigits
facet.boolean
Returnstrue
if this facet is alength
facet.boolean
Returnstrue
if this facet is amaxLength
facet.boolean
Returnstrue
if this facet is aminLength
facet.boolean
Returnstrue
if this facet is related to a mandatory field (defines bothminOccurs="1"
maxOccurs="1"
).
boolean
Returnstrue
if this facet is aresource
constraint.boolean
Returnstrue
if this facet is apattern
facet.boolean
Returnstrue
if this facet is atotalDigits
facet.
-
Method Details
-
getSchemaNode
SchemaNode getSchemaNode()Returns the node associated to this facet.- Since:
- 6.0.0
-
getDocumentation
Returns the end-user documentation for this facet. This method can returnnull
on programmatic extended facets if it is called during the compilation of the associated data model.- Throws:
IllegalArgumentException
- if an argument isnull
.- See Also:
-
isFacetOnMandatoryField
boolean isFacetOnMandatoryField()Returnstrue
if this facet is related to a mandatory field (defines bothminOccurs="1"
maxOccurs="1"
).
- Since:
- 6.0.0
- See Also:
-
isFacetLength
boolean isFacetLength()Returnstrue
if this facet is alength
facet.- See Also:
-
isFacetMinLength
boolean isFacetMinLength()Returnstrue
if this facet is aminLength
facet.- See Also:
-
isFacetMaxLength
boolean isFacetMaxLength()Returnstrue
if this facet is amaxLength
facet.- See Also:
-
isFacetPattern
boolean isFacetPattern()Returnstrue
if this facet is apattern
facet.- See Also:
-
isFacetOResource
boolean isFacetOResource()Returnstrue
if this facet is aresource
constraint.- See Also:
-
isEnumerationList
boolean isEnumerationList()Returnstrue
if this facet defines an enumeration of possible values. This is the case for the following facets:- a
foreign key
constraint; - a static enumeration defined with the standard XML Schema facet
xs:enumeration
; - a dynamic enumeration defined with the extended facet
osd:enumeration
; - a programmatic
enumeration constraint
.
- See Also:
- a
-
isEnumerationNomenclature
boolean isEnumerationNomenclature()Returnstrue
if this facet defines a nomenclature. This is the case for the following facets:- a static nomenclature defined with the extended facet
osd:nomenclature
(deprecated); - a resource facet,
osd:FacetOResource
; - a dynamic nomenclature defined with the extended facet
osd:nomenclature
(deprecated); - a programmatic
nomenclature constraint
(deprecated).
- See Also:
- a static nomenclature defined with the extended facet
-
isFacetEnumeration
boolean isFacetEnumeration()Returnstrue
if this facet defines either anenumeration
or anomenclature
. -
isEnumerationTableRef
boolean isEnumerationTableRef()Returnstrue
if this facet is a foreign key constraint (osd:tableRef
).- See Also:
-
isFacetBoundaryMaxInclusive
boolean isFacetBoundaryMaxInclusive()Returnstrue
if this facet is amaxInclusive
facet.- See Also:
-
isFacetBoundaryMaxExclusive
boolean isFacetBoundaryMaxExclusive()Returnstrue
if this facet is amaxExclusive
facet.- See Also:
-
isFacetBoundaryMinExclusive
boolean isFacetBoundaryMinExclusive()Returnstrue
if this facet is aminExclusive
facet.- See Also:
-
isFacetBoundaryMinInclusive
boolean isFacetBoundaryMinInclusive()Returnstrue
if this facet is aminInclusive
facet.- See Also:
-
isFacetTotalDigits
boolean isFacetTotalDigits()Returnstrue
if this facet is atotalDigits
facet.- See Also:
-
isFacetFractionDigits
boolean isFacetFractionDigits()Returnstrue
if this facet is afractionDigits
facet.- See Also:
-
isFacetExcludeValue
boolean isFacetExcludeValue()Returnstrue
if this facet is anexcludeValue
facet.- See Also:
-
isFacetExcludeSegment
boolean isFacetExcludeSegment()Returnstrue
if this facet is anexcludeSegment
facet.- See Also:
-
getValidationPolicy
SchemaFacetValidationPolicy getValidationPolicy()Returns the validation policy of this facet. Validation policy properties are defined under the elementosd:validation
.- Since:
- 5.8.1
- See Also:
-
getFacetValidationMessage
SchemaFacetValidationMessage getFacetValidationMessage()Returns the validation message defined in the data model. Validation messages are defined within the elementosd:validation
,osd:enumerationValidation
orosd:mandatoryErrorMessage
.- Since:
- 6.0.0
- See Also:
-