Package aas_core.aas3_0.enhancing

Class EnhancedFile<EnhancementT>

java.lang.Object

aas_core.aas3_0.enhancing.Enhanced<EnhancementT>

aas_core.aas3_0.enhancing.EnhancedFile<EnhancementT>

All Implemented Interfaces:

IClass, IDataElement, IFile, IHasDataSpecification, IHasExtensions, IHasSemantics, IQualifiable, IReferable, ISubmodelElement

public class EnhancedFile<EnhancementT>
extends Enhanced<EnhancementT>
implements IFile

Field Summary

Fields inherited from class aas_core.aas3_0.enhancing.Enhanced

enhancement

Constructor Summary

Constructors

Constructor	Description
EnhancedFile(IFile instance, EnhancementT enhancement)

Method Summary

Modifier and Type	Method	Description
void	accept(IVisitor visitor)	Accept the visitor to visit this instance for double dispatch.
<ContextT> void	accept(IVisitorWithContext<ContextT> visitor, ContextT context)	Accept the visitor to visit this instance for double dispatch with the context.
String	categoryOrDefault()
Iterable<IClass>	descend()	Iterate recursively over all the class instances referenced from this instance.
Iterable<IClass>	descendOnce()	Iterate over all the class instances referenced from this instance without further recursion.
Optional<String>	getCategory()	The category is a value that gives further meta information w.r.t. to the class of the element.
String	getContentType()	Content type of the content of the file.
Optional<List<ILangStringTextType>>	getDescription()	Description or comments on the element.
Optional<List<ILangStringNameType>>	getDisplayName()	Display name.
Optional<List<IEmbeddedDataSpecification>>	getEmbeddedDataSpecifications()	Embedded data specification.
Optional<List<IExtension>>	getExtensions()	An extension of the element.
Optional<String>	getIdShort()	In case of identifiables this attribute is a short name of the element.
Optional<List<IQualifier>>	getQualifiers()	Additional qualification of a qualifiable element.
Optional<IReference>	getSemanticId()	Identifier of the semantic definition of the element.
Optional<List<IReference>>	getSupplementalSemanticIds()	Identifier of a supplemental semantic definition of the element.
Optional<String>	getValue()	Path and name of the referenced file (with file extension).
Iterable<ILangStringTextType>	overDescriptionOrEmpty()	Iterate over description, if set, and otherwise return an empty enumerable.
Iterable<ILangStringNameType>	overDisplayNameOrEmpty()	Iterate over displayName, if set, and otherwise return an empty enumerable.
Iterable<IEmbeddedDataSpecification>	overEmbeddedDataSpecificationsOrEmpty()	Iterate over embeddedDataSpecifications, if set, and otherwise return an empty enumerable.
Iterable<IExtension>	overExtensionsOrEmpty()	Iterate over extensions, if set, and otherwise return an empty enumerable.
Iterable<IQualifier>	overQualifiersOrEmpty()	Iterate over qualifiers, if set, and otherwise return an empty enumerable.
Iterable<IReference>	overSupplementalSemanticIdsOrEmpty()	Iterate over supplementalSemanticIds, if set, and otherwise return an empty enumerable.
void	setCategory(String category)
void	setContentType(String contentType)
void	setDescription(List<ILangStringTextType> description)
void	setDisplayName(List<ILangStringNameType> displayName)
void	setEmbeddedDataSpecifications(List<IEmbeddedDataSpecification> embeddedDataSpecifications)
void	setExtensions(List<IExtension> extensions)
void	setIdShort(String idShort)
void	setQualifiers(List<IQualifier> qualifiers)
void	setSemanticId(IReference semanticId)
void	setSupplementalSemanticIds(List<IReference> supplementalSemanticIds)
void	setValue(String value)
<T> T	transform(ITransformer<T> transformer)	Accept the transformer to transform this instance for double dispatch.
<ContextT, T> T	transform(ITransformerWithContext<ContextT,T> transformer, ContextT context)	Accept the transformer to visit this instance for double dispatch with the context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EnhancedFile

public EnhancedFile(IFile instance,
 EnhancementT enhancement)

Method Details

getExtensions

public Optional<List<IExtension>> getExtensions()

Description copied from interface: IHasExtensions

An extension of the element.

Specified by:

getExtensions in interface IHasExtensions

setExtensions

public void setExtensions(List<IExtension> extensions)

Specified by:

setExtensions in interface IHasExtensions

getCategory

public Optional<String> getCategory()

Description copied from interface: IReferable

The category is a value that gives further meta information w.r.t. to the class of the element. It affects the expected existence of attributes and the applicability of constraints.

The category is not identical to the semantic definition (IHasSemantics) of an element. The category e.g. could denote that the element is a measurement value whereas the semantic definition of the element would denote that it is the measured temperature.

Specified by:

getCategory in interface IReferable

setCategory

public void setCategory(String category)

Specified by:

setCategory in interface IReferable

getIdShort

public Optional<String> getIdShort()

Description copied from interface: IReferable

In case of identifiables this attribute is a short name of the element. In case of referable this ID is an identifying string of the element within its name space.

In case the element is a property and the property has a semantic definition (IHasSemantics.getSemanticId()) conformant to IEC61360 the IReferable.getIdShort() is typically identical to the short name in English.

Specified by:

getIdShort in interface IReferable

setIdShort

public void setIdShort(String idShort)

Specified by:

setIdShort in interface IReferable

getDisplayName

public Optional<List<ILangStringNameType>> getDisplayName()

Description copied from interface: IReferable

Display name. Can be provided in several languages.

Specified by:

getDisplayName in interface IReferable

setDisplayName

public void setDisplayName(List<ILangStringNameType> displayName)

Specified by:

setDisplayName in interface IReferable

getDescription

public Optional<List<ILangStringTextType>> getDescription()

Description copied from interface: IReferable

Description or comments on the element.

The description can be provided in several languages.

If no description is defined, then the definition of the concept description that defines the semantics of the element is used.

Additional information can be provided, e.g., if the element is qualified and which qualifier types can be expected in which context or which additional data specification templates are provided.

Specified by:

getDescription in interface IReferable

setDescription

public void setDescription(List<ILangStringTextType> description)

Specified by:

setDescription in interface IReferable

getSemanticId

public Optional<IReference> getSemanticId()

Description copied from interface: IHasSemantics

Identifier of the semantic definition of the element. It is called semantic ID of the element or also main semantic ID of the element.

It is recommended to use a global reference.

Specified by:

getSemanticId in interface IHasSemantics

setSemanticId

public void setSemanticId(IReference semanticId)

Specified by:

setSemanticId in interface IHasSemantics

getSupplementalSemanticIds

public Optional<List<IReference>> getSupplementalSemanticIds()

Description copied from interface: IHasSemantics

Identifier of a supplemental semantic definition of the element. It is called supplemental semantic ID of the element.

It is recommended to use a global reference.

Specified by:

getSupplementalSemanticIds in interface IHasSemantics

setSupplementalSemanticIds

public void setSupplementalSemanticIds(List<IReference> supplementalSemanticIds)

Specified by:

setSupplementalSemanticIds in interface IHasSemantics

getQualifiers

public Optional<List<IQualifier>> getQualifiers()

Description copied from interface: IQualifiable

Additional qualification of a qualifiable element.

Constraints:

• Constraint AASd-021: Every qualifiable can only have one qualifier with the same Qualifier.getType().

Specified by:

getQualifiers in interface IQualifiable

setQualifiers

public void setQualifiers(List<IQualifier> qualifiers)

Specified by:

setQualifiers in interface IQualifiable

getEmbeddedDataSpecifications

public Optional<List<IEmbeddedDataSpecification>> getEmbeddedDataSpecifications()

Description copied from interface: IHasDataSpecification

Embedded data specification.

Specified by:

getEmbeddedDataSpecifications in interface IHasDataSpecification

setEmbeddedDataSpecifications

public void setEmbeddedDataSpecifications(List<IEmbeddedDataSpecification> embeddedDataSpecifications)

Specified by:

setEmbeddedDataSpecifications in interface IHasDataSpecification

getValue

public Optional<String> getValue()

Description copied from interface: IFile

Path and name of the referenced file (with file extension).

The path can be absolute or relative.

Specified by:

getValue in interface IFile

setValue

public void setValue(String value)

Specified by:

setValue in interface IFile

getContentType

public String getContentType()

Description copied from interface: IFile

Content type of the content of the file.

The content type states which file extensions the file can have.

Specified by:

getContentType in interface IFile

setContentType

public void setContentType(String contentType)

Specified by:

setContentType in interface IFile

overExtensionsOrEmpty

public Iterable<IExtension> overExtensionsOrEmpty()

Description copied from interface: IHasExtensions

Iterate over extensions, if set, and otherwise return an empty enumerable.

Specified by:

overExtensionsOrEmpty in interface IHasExtensions

overDisplayNameOrEmpty

public Iterable<ILangStringNameType> overDisplayNameOrEmpty()

Description copied from interface: IReferable

Iterate over displayName, if set, and otherwise return an empty enumerable.

Specified by:

overDisplayNameOrEmpty in interface IReferable

overDescriptionOrEmpty

public Iterable<ILangStringTextType> overDescriptionOrEmpty()

Description copied from interface: IReferable

Iterate over description, if set, and otherwise return an empty enumerable.

Specified by:

overDescriptionOrEmpty in interface IReferable

overSupplementalSemanticIdsOrEmpty

public Iterable<IReference> overSupplementalSemanticIdsOrEmpty()

Description copied from interface: IHasSemantics

Iterate over supplementalSemanticIds, if set, and otherwise return an empty enumerable.

Specified by:

overSupplementalSemanticIdsOrEmpty in interface IHasSemantics

overQualifiersOrEmpty

public Iterable<IQualifier> overQualifiersOrEmpty()

Description copied from interface: IQualifiable

Iterate over qualifiers, if set, and otherwise return an empty enumerable.

Specified by:

overQualifiersOrEmpty in interface IQualifiable

overEmbeddedDataSpecificationsOrEmpty

public Iterable<IEmbeddedDataSpecification> overEmbeddedDataSpecificationsOrEmpty()

Description copied from interface: IHasDataSpecification

Iterate over embeddedDataSpecifications, if set, and otherwise return an empty enumerable.

Specified by:

overEmbeddedDataSpecificationsOrEmpty in interface IHasDataSpecification

categoryOrDefault

public String categoryOrDefault()

Specified by:

categoryOrDefault in interface IDataElement

descendOnce

public Iterable<IClass> descendOnce()

Description copied from interface: IClass

Iterate over all the class instances referenced from this instance without further recursion.

Specified by:

descendOnce in interface IClass

descend

public Iterable<IClass> descend()

Description copied from interface: IClass

Iterate recursively over all the class instances referenced from this instance.

Specified by:

descend in interface IClass

accept

public void accept(IVisitor visitor)

Description copied from interface: IClass

Accept the visitor to visit this instance for double dispatch.

Specified by:

accept in interface IClass

accept

public <ContextT> void accept(IVisitorWithContext<ContextT> visitor,
 ContextT context)

Description copied from interface: IClass

Accept the visitor to visit this instance for double dispatch with the context.

Specified by:

accept in interface IClass

transform

public <T> T transform(ITransformer<T> transformer)

Description copied from interface: IClass

Accept the transformer to transform this instance for double dispatch.

Specified by:

transform in interface IClass

transform

public <ContextT,
T> T transform(ITransformerWithContext<ContextT,T> transformer,
 ContextT context)

Description copied from interface: IClass

Accept the transformer to visit this instance for double dispatch with the context.

Specified by:

transform in interface IClass