public interface ReferenceConstructionAgent
store elements, data sets
, and
external URLs
.ReferenceTransformationAgent
,
ReferenceHolder
Modifier and Type | Field and Description |
---|---|
static SpecialistType<ReferenceConstructionAgent> |
TYPE
Agent providing means to create reference holding containers for
store elements , data sets, and external URLs. |
Modifier and Type | Method and Description |
---|---|
IDProviderReferenceHolder |
create(IDProvider element,
String remoteConfigName)
Create an element referencing container from a given id providing store element.
|
IDProviderReferenceHolder |
create(String uid,
IDProvider.UidType uidType,
String remoteConfigName)
Create an element referencing container on given store element information.
|
ExternalReferenceHolder |
create(String resource,
String category)
Create an external referencing container from a given resource (e.g. an URL) and category.
|
IDProviderReferenceHolder |
create(String schemaUid,
String entityTypeName,
KeyValue keyValue,
String remoteConfigName)
Create a dataset referencing container on given information.
|
IDProviderReferenceHolder |
create(String schemaUid,
String entityTypeName,
UUID gid,
String remoteConfigName)
Create a dataset referencing container on given information.
|
static final SpecialistType<ReferenceConstructionAgent> TYPE
store elements
, data sets, and external URLs.@NotNull IDProviderReferenceHolder create(@NotNull IDProvider element, @Nullable String remoteConfigName) throws IllegalArgumentException
Note: If the given element is of type Dataset, it must originate from a content source
.
This is met if the dataset is returned by a SelectStoreElementOperation
.
element
- The store element.remoteConfigName
- Name of the remote configuration.IllegalArgumentException
- If a the given element and/or remote information do not satisfy the requirements for building a reference container.IDProviderReferenceHolder create(@NotNull String uid, @NotNull IDProvider.UidType uidType, @Nullable String remoteConfigName)
uid
- The element's uid.uidType
- The element's uid type.remoteConfigName
- Name of the remote configuration.IDProviderReferenceHolder create(@NotNull String schemaUid, @NotNull String entityTypeName, @NotNull UUID gid, @Nullable String remoteConfigName)
schemaUid
- The schema's uid the referenced dataset originates from.entityTypeName
- The name of the entity type (table) in the schema.gid
- The dataset's gid.remoteConfigName
- Name of the remote configuration.IDProviderReferenceHolder create(@NotNull String schemaUid, @NotNull String entityTypeName, @NotNull KeyValue keyValue, @Nullable String remoteConfigName)
schemaUid
- The schema's uid the referenced dataset originates from.entityTypeName
- The name of the entity type (table) in the schema.keyValue
- The dataset's key value.remoteConfigName
- Name of the remote configuration.@NotNull ExternalReferenceHolder create(@NotNull String resource, @Nullable String category)
resource
- an external resource.category
- The category of the identifier - if null
the default category "url" is used.Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210