public interface ClassInfo extends Info
Modifier and Type | Method and Description |
---|---|
boolean |
asCharacterString()
If a <
|
boolean |
asDictionary()
Find out if this class has to be output as a dictionary.
|
boolean |
asDictionaryGml33()
Find out if this class has to be output as a dictionary.
|
boolean |
asGroup()
If a <
|
ClassInfo |
baseClass()
This determines the particular base class of a class in the sense of
ISO19136 annex D+E.
|
int |
category()
Return the category of the class.
|
boolean |
checkSupertypes(int cat)
This is supposed to find out, whether the given category 'cat' applied in
'this' class complies to the categories of all its base classes.
|
List<Constraint> |
constraints()
This method returns the constraints associated with the class.
|
List<ImageMetadata> |
getDiagrams() |
File |
getLinkedDocument() |
boolean |
hasConstraint(String name)
Find out whether this class owns a constraint of the given name.
|
boolean |
hasNilReason() |
boolean |
includeByValuePropertyType()
Determine whether a property type shall be included in the schema for the
object type that does not support Xlinks but requires encoding the
property value inline.
|
boolean |
includePropertyType()
Determine whether a standard property type shall be included in the
schema.
|
boolean |
inSchema(PackageInfo pi)
Check whether the class and the package pi are part of the same schema (=
XML namespace).
|
boolean |
isAbstract() |
AssociationInfo |
isAssocClass() |
boolean |
isCollection()
This predicate determines if the class is a collection.
|
boolean |
isKindOf(String supertypeName)
Determine if this type is of the given kind, i.e. if one of its (direct
or indirect) supertypes has a name that equals the given one.
|
boolean |
isLeaf() |
boolean |
isSubtype(ClassInfo ci)
Determine whether this type is a direct or indirect subtype of the
argument type.
|
boolean |
isUnionDirect()
Special case of a <
|
OperationInfo |
operation(String name,
String[] types) |
PropertyInfo |
ownedProperty(String name)
Look up the property with the given name in the properties owned by this
class.
|
PackageInfo |
pkg() |
Profiles |
profiles() |
SortedMap<StructuredNumber,PropertyInfo> |
properties()
Get a map of all navigable properties (attributes and association roles)
that belong to this class - NOT one of its base classes.
|
SortedSet<PropertyInfo> |
propertiesAll()
Get a set of all navigable properties (attributes and association roles)
that belong to this class or one of the types in its supertype hierarchy.
|
PropertyInfo |
property(String name)
Find the property given by its name in this class or (if not present
there) recursively in its base classes.
|
String |
qname()
Return the namespace-prefixed class name.
|
void |
setDiagrams(List<ImageMetadata> diagrams) |
void |
setLinkedDocument(File linkedDocument) |
SortedSet<String> |
subtypes() |
SortedSet<ClassInfo> |
subtypesInCompleteHierarchy() |
SortedSet<String> |
supertypes()
Provides the ids of all direct base classes of this class (includes the
class that is returned by method
baseClass() ). |
SortedSet<ClassInfo> |
supertypesInCompleteHierarchy() |
boolean |
suppressed()
Determine whether this is a 'suppressed' class.
|
ClassInfo |
unsuppressedSupertype(boolean permitAbstract)
Find the next direct or indirect superclass of this class which is not
suppressed.
|
String |
xmlSchemaType() |
aliasName, dataCaptureStatements, definition, derivedDocumentation, description, descriptors, documentation, encodingRule, examples, fullName, fullNameInSchema, globalIdentifier, id, language, legalBasis, matches, model, name, options, postprocessAfterLoadingAndValidate, primaryCode, removeTaggedValue, result, stereotype, stereotypes, taggedValue, taggedValueInLanguage, taggedValues, taggedValues, taggedValuesAll, taggedValuesForTag, taggedValuesForTagAsLangStrings, taggedValuesForTagList, taggedValuesInLanguage, validateStereotypesCache, validateTaggedValuesCache
compareTo
String xmlSchemaType()
null
is returned.boolean includePropertyType()
boolean includeByValuePropertyType()
boolean isCollection()
boolean asDictionary()
boolean asGroup()
boolean asCharacterString()
boolean hasNilReason()
true
if the class has a property (not inherited from
a supertype) for which
PropertyInfo.implementedByNilReason()
is
true
, else false
.PackageInfo pkg()
boolean isAbstract()
boolean isLeaf()
AssociationInfo isAssocClass()
SortedSet<String> supertypes()
baseClass()
).SortedSet<String> subtypes()
null
.SortedSet<ClassInfo> subtypesInCompleteHierarchy()
null
SortedSet<ClassInfo> supertypesInCompleteHierarchy()
null
boolean inSchema(PackageInfo pi)
ClassInfo baseClass()
String qname()
int category()
boolean checkSupertypes(int cat)
SortedMap<StructuredNumber,PropertyInfo> properties()
null
.SortedSet<PropertyInfo> propertiesAll()
null
.List<Constraint> constraints()
null
boolean hasConstraint(String name)
PropertyInfo property(String name)
name
- null
if no property was foundPropertyInfo ownedProperty(String name)
name
- null
if no such
property exists.OperationInfo operation(String name, String[] types)
boolean isSubtype(ClassInfo ci)
boolean isKindOf(String supertypeName)
supertypeName
- boolean suppressed()
ClassInfo unsuppressedSupertype(boolean permitAbstract)
boolean asDictionaryGml33()
boolean isUnionDirect()
List<ImageMetadata> getDiagrams()
null
if no diagrams are availablevoid setDiagrams(List<ImageMetadata> diagrams)
diagrams
- metadata about the diagrams relevant for this classFile getLinkedDocument()
null
void setLinkedDocument(File linkedDocument)
linkedDocument
- a .docx file that is linked to this class; can be
null
Profiles profiles()
null
Copyright © 2018. All rights reserved.