public abstract class TransformationApi
extends java.lang.Object
Constructor and Description |
---|
TransformationApi() |
Modifier and Type | Method and Description |
---|---|
static ProfileAction |
addAttribute(java.lang.String name,
java.lang.Class<?> clazz,
boolean defaultValue) |
static ProfileAction |
addAttribute(java.lang.String name,
java.lang.Class<?> clazz,
long defaultValue) |
static ProfileAction |
addAttribute(java.lang.String name,
java.lang.Class<?> clazz,
ObjectGenerator defaultValue) |
static ProfileAction |
addAttribute(java.lang.String name,
java.lang.Class<?> clazz,
java.lang.String defaultValue) |
static ProfileAction |
addAttribute(java.lang.String name,
java.lang.Class<?> clazz,
ValueFunction function) |
static ProfileAction |
addAttribute(java.lang.String name,
java.lang.String type,
boolean defaultValue) |
static ProfileAction |
addAttribute(java.lang.String name,
java.lang.String type,
long defaultValue) |
static ProfileAction |
addAttribute(java.lang.String name,
java.lang.String type,
ObjectGenerator defaultValue)
The addAttribute() action rule adds a new non-serialised attribute by specifying its name and type, and optionally
a default value to be used when no other more specific value is given, and when an attribute value was not already
present within the export data.
|
static ProfileAction |
addAttribute(java.lang.String name,
java.lang.String type,
java.lang.String defaultValue) |
static ProfileAction |
addAttribute(java.lang.String name,
java.lang.String type,
java.lang.String serialisationVersion,
ObjectGenerator defaultValue)
The addAttribute() action rule adds a new serialised attribute by specifying its name and type, and optionally
a default value to be used when no other more specific value is given, and when an attribute value was not already
present within the export data.
|
static ProfileAction |
addAttribute(java.lang.String name,
java.lang.String type,
java.lang.String serialisationVersion,
java.lang.String defaultValue)
Adds a serialised attribute.
|
static ProfileAction |
addAttribute(java.lang.String name,
java.lang.String type,
java.lang.String serialisationVersion,
ValueFunction function)
Adds a serialised attribute.
|
static ProfileAction |
addAttribute(java.lang.String name,
java.lang.String type,
ValueFunction function)
This is a specialized form of the addAttribute() rule, where the default value is the null value.
|
static ProfileAction |
addAttributeAsNull(java.lang.String name,
java.lang.Class<?> clazz)
This is a specialized form of the addAttribute() rule, where the default value is the null value.
|
static ProfileAction |
addAttributeAsNull(java.lang.String name,
java.lang.String type)
This is a specialized form of the addAttribute() rule, where the default value is the null value.
|
static ProfileAction |
addAttributeAsNull(java.lang.String name,
java.lang.String type,
java.lang.String serialisationVersion)
Adds a serialised attribute.
|
static RaConfigAction |
addProperty(java.lang.String name,
java.lang.Class<?> clazz,
boolean defaultValue) |
static RaConfigAction |
addProperty(java.lang.String name,
java.lang.Class<?> clazz,
long defaultValue) |
static RaConfigAction |
addProperty(java.lang.String name,
java.lang.Class<?> clazz,
ObjectGenerator.StringGenerator defaultValue) |
static RaConfigAction |
addProperty(java.lang.String name,
java.lang.Class<?> clazz,
java.lang.String defaultValue) |
static RaConfigAction |
addProperty(java.lang.String name,
java.lang.String type,
boolean defaultValue) |
static RaConfigAction |
addProperty(java.lang.String name,
java.lang.String type,
long defaultValue) |
static RaConfigAction |
addProperty(java.lang.String name,
java.lang.String type,
ObjectGenerator.StringGenerator defaultValue)
Adds a configuration property to an RA entity.
|
static RaConfigAction |
addProperty(java.lang.String name,
java.lang.String type,
java.lang.String defaultValue) |
static RaConfigAction |
addPropertyAsNull(java.lang.String name,
java.lang.Class<?> clazz)
This is a specialized form of addProperty that has null as the default value.
|
static RaConfigAction |
addPropertyAsNull(java.lang.String name,
java.lang.String type)
This is a specialized form of addProperty that has null as the default value.
|
static StringMatcher |
anyString()
Returns a matcher object that matches any string.
|
static ObjectGenerator |
array()
Used for generating an empty array.
|
static ObjectGenerator |
array(java.lang.Object... values)
Used for generating an array from arbitrary and mixed argument types.
|
static ObjectGenerator |
array(ObjectGenerator... values)
Used for generating an array value, whose individual elements
are generated in turn by the given generators, 1 value per generator.
|
static ObjectGenerator |
array(java.lang.String... values)
Used for generating a String array, with the given fixed values.
|
static ProfileAction |
changeAttributeType(java.lang.String name,
java.lang.Class<?> clazz) |
static ProfileAction |
changeAttributeType(java.lang.String name,
java.lang.String newType)
The changeAttributeType() rule changes the type of the name attribute.
|
static ComponentMatcher |
component(StringMatcher name,
StringMatcher vendor,
java.lang.String version) |
static ComponentMatcher |
component(StringMatcher name,
StringMatcher vendor,
StringMatcher version) |
static ComponentMatcher |
component(StringMatcher name,
java.lang.String vendor,
java.lang.String version) |
static ComponentMatcher |
component(StringMatcher name,
java.lang.String vendor,
StringMatcher version) |
static ComponentMatcher |
component(java.lang.String name,
StringMatcher vendor,
java.lang.String version) |
static ComponentMatcher |
component(java.lang.String name,
StringMatcher vendor,
StringMatcher version) |
static ComponentMatcher |
component(java.lang.String name,
java.lang.String vendor,
java.lang.String version)
Returns a ComponentMatcher object for use by ProfileSpec context rules.
|
static ComponentMatcher |
component(java.lang.String name,
java.lang.String vendor,
StringMatcher version) |
static ProfileAction |
createProfile(java.lang.String name)
The createProfile() action rule is used to create a new named profile within a profile table.
|
static ProfileTableCreationRule |
createTable(java.lang.String tableName,
java.lang.String specName,
java.lang.String specVendor,
java.lang.String specVersion)
The createTable() action rule is unique in that it is the one action rule that does not need to be enclosed in a context rule.
|
static ProfileAction |
doNotImportAttribute(java.lang.String name)
The doNotImportAttribute() action deletes a named attribute from the exported data for a profile table.
|
static ProfileAction |
doNotImportProfile()
The doNotImportProfile() rule deletes the profile from the export data.
|
static ProfileAction |
doNotImportProfileTable()
The doNotImportProfileTable() rule deletes an entire profile table from the export data.
|
static RaConfigAction |
doNotImportProperty(java.lang.String name)
This action rule deletes an RA configuration property from the exported data.
|
static RaConfigAction |
doNotImportRaEntity()
Deletes the RA entity from the exported data.
|
static ValueFunction |
functionArrayAddUniqueValues(java.lang.String... values)
Returns a function that only adds the unique given values to an array in a profile attribute value.
|
static ValueFunction |
functionArrayAppend(java.lang.String... values)
Returns a function that appends the given values to an array in a profile attribute value.
|
static ValueFunction |
functionArrayRemove(java.lang.String... values)
Returns a function that removes the given values from an array in a profile attribute value.
|
static ValueFunction |
functionForConstant(java.lang.Object value)
Returns a function which always returns the given value, which may be null.
|
static ValueFunction |
functionForDefaultProfileAndOthers(java.lang.String valueForDefaultProfile,
java.lang.String valueForNonDefaultProfiles) |
static ValueFunction |
functionForDefaultProfileAndOthers(java.lang.String valueForDefaultProfile,
ValueFunction valueForNonDefaultProfiles) |
static ValueFunction |
functionForDefaultProfileAndOthers(ValueFunction valueForDefaultProfile,
java.lang.String valueForNonDefaultProfiles) |
static ValueFunction |
functionForDefaultProfileAndOthers(ValueFunction valueForDefaultProfile,
ValueFunction valueForNonDefaultProfiles)
Returns a function that uses the first value if editing the default profile,
or the second value if editing a non-default profile.
|
ValueFunction |
functionUplevelProfileAttribute()
Returns a function that uses the existing uplevel value for the
relevant profile attribute.
|
ValueFunction |
functionUplevelProfileAttributeArray()
Returns a function that uses the existing uplevel value for the relevant profile attribute which has
an array type.
|
java.lang.String |
getProfileAttribute(java.lang.String profileTable,
java.lang.String profileName,
java.lang.String attributeName)
Get the current (i.e. prior to upgrade) value of a profile attribute.
|
java.lang.String[] |
getProfileAttributeArray(java.lang.String profileTable,
java.lang.String profileName,
java.lang.String attributeName)
Get the current (i.e. prior to upgrade) value of a profile attribute which has an array type.
|
java.lang.String[] |
getProfileNames(java.lang.String profileTable)
Get an array of all the profile names in the specified profile table.
|
java.lang.String |
getRaProperty(java.lang.String entityName,
java.lang.String propertyName)
Get the current (i.e. prior to upgrade) value of a property.
|
java.lang.String |
getUplevelProfileAttribute(java.lang.String profileTable,
java.lang.String profileName,
java.lang.String attributeName)
Get the uplevel (i.e. present in the upgraded version) value of a profile attribute.
|
java.lang.String[] |
getUplevelProfileAttributeArray(java.lang.String profileTable,
java.lang.String profileName,
java.lang.String attributeName)
Get the uplevel (i.e. present in the upgraded version) value of a profile attribute which has an array type.
|
java.lang.String[] |
getUplevelProfileNames(java.lang.String profileTable)
Gets an array of all the profile names in the uplevel version of the specified profile table.
|
java.lang.String |
getUplevelRaProperty(java.lang.String entityName,
java.lang.String propertyName)
Get the uplevel (i.e. present in the upgraded version) value of a property.
|
static ProfileRule |
ifAttributeValue(java.lang.String name,
StringMatcher value,
ProfileRuleChild... children) |
static ProfileRule |
ifAttributeValue(java.lang.String name,
java.lang.String value,
ProfileRuleChild... children)
The ifAttributeValue() context rule will have its child rules applied only if the specified profile attribute matches the specified value.
|
static ProfileRule |
ifAttributeValueIsNull(java.lang.String name,
ProfileRuleChild... children)
The ifAttributeValueIsNull() context rule is a specialized form of the ifAttributeValue() rule
that matches on the profile attribute value being null.
|
static RaConfigRule |
ifPropertyValue(java.lang.String name,
StringMatcher value,
RaConfigRuleChild... children) |
static RaConfigRule |
ifPropertyValue(java.lang.String name,
java.lang.String value,
RaConfigRuleChild... children)
The ifPropertyValue() context rule will have its child rules applied only if
the specified RA configuration property matches the specified value.
|
static RaConfigRule |
ifPropertyValueIsNull(java.lang.String name,
RaConfigRuleChild... children)
The ifPropertyValueIsNull() context rule is a specialized form of the ifPropertyValue() rule
that matches on a value being null.
|
void |
issueWarning(java.lang.String message)
The primary use for the issueWarning() method is so that code that uses the API can issue a warning,
for example if it discovers that the data it is transforming is too complex to be automatically handled.
|
static ProfileRule |
profileName(StringMatcher profileName,
ProfileRuleChild... children) |
static ProfileRule |
profileName(java.lang.String profileName,
ProfileRuleChild... children)
The profileName() context rule is used to identify which profile name needs to be matched in order
for the child rules to be applied.
|
static ProfileRule |
profileSpec(ComponentMatcher profileSpecId,
ProfileRuleChild... children)
The profileSpec() context rule is used to identify which profile specs need to be matched
in order for the child rules to be applied.
|
static ProfileRule |
profileSpec(StringMatcher name,
StringMatcher vendor,
StringMatcher version,
ProfileRuleChild... children) |
static ProfileRule |
profileSpec(StringMatcher name,
StringMatcher vendor,
java.lang.String version,
ProfileRuleChild... children) |
static ProfileRule |
profileSpec(StringMatcher name,
java.lang.String vendor,
StringMatcher version,
ProfileRuleChild... children) |
static ProfileRule |
profileSpec(StringMatcher name,
java.lang.String vendor,
java.lang.String version,
ProfileRuleChild... children) |
static ProfileRule |
profileSpec(java.lang.String name,
StringMatcher vendor,
StringMatcher version,
ProfileRuleChild... children) |
static ProfileRule |
profileSpec(java.lang.String name,
StringMatcher vendor,
java.lang.String version,
ProfileRuleChild... children) |
static ProfileRule |
profileSpec(java.lang.String name,
java.lang.String vendor,
StringMatcher version,
ProfileRuleChild... children) |
static ProfileRule |
profileSpec(java.lang.String name,
java.lang.String vendor,
java.lang.String version,
ProfileRuleChild... children) |
static ProfileRule |
profileTable(StringMatcher tableName,
ProfileRuleChild... children) |
static ProfileRule |
profileTable(java.lang.String tableName,
ProfileRuleChild... children)
The profileTable() context rule is used to identify which profile table needs to be matched
in order for the child rules to be applied.
|
static RaConfigRule |
raEntity(StringMatcher entityName,
RaConfigRuleChild... children) |
static RaConfigRule |
raEntity(java.lang.String entityName,
RaConfigRuleChild... children)
The raEntity() context rule is used to select on entity names.
|
static StringMatcher |
regex(java.lang.String pattern)
Returns a matcher object based on the given regular expression.
|
static ProfileAction |
renameAttribute(java.lang.String originalName,
java.lang.String newName)
The renameAttribute() rule changes the name of an attribute, without affecting its type or value.
|
static ProfileAction |
renameProfile(java.lang.String newName) |
static ProfileAction |
renameProfile(ValueFunction newName)
The renameProfile() rule renames a profile.
|
static ProfileAction |
renameProfileSpec(java.lang.String newName)
Changes the name of the profile spec which is associated with the profile table in the current context.
|
static ProfileAction |
renameProfileTable(java.lang.String newName)
Renames a profile table.
|
static RaConfigAction |
renameProperty(java.lang.String originalName,
java.lang.String newName)
Renames an RA configuration property.
|
static RaConfigAction |
renameRaEntity(java.lang.String newName)
Renames the RA entity.
|
abstract Rule[] |
rules(RulesContext rulesContext)
This is the method that all API users must implement.
|
static ProfileAction |
setAttribute(java.lang.String name,
boolean newValue) |
static ProfileAction |
setAttribute(java.lang.String name,
int[] newValue) |
static ProfileAction |
setAttribute(java.lang.String name,
long newValue) |
static ProfileAction |
setAttribute(java.lang.String name,
long[] newValue) |
static ProfileAction |
setAttribute(java.lang.String name,
java.lang.Object[] newValue) |
static ProfileAction |
setAttribute(java.lang.String name,
ObjectGenerator newValue)
The setAttribute() action rule sets a named attribute to a particular value.
|
static ProfileAction |
setAttribute(java.lang.String name,
java.lang.String newValue) |
static ProfileAction |
setAttribute(java.lang.String name,
ValueFunction function) |
static ProfileAction |
setAttributeToNull(java.lang.String name)
This is a specialized form of the setAttribute action rule that uses a value of null.
|
void |
setEnvironment(java.util.List<org.w3c.dom.Document> documents,
com.opencloud.slee.data.migration.ExportData exportData,
java.util.List<org.w3c.dom.Document> uplevelDocuments,
com.opencloud.slee.data.migration.ExportData uplevelData)
This method is not part of the API.
|
void |
setProblemCollector(ProblemCollector problemCollector)
This method is not part of the API.
|
static RaConfigAction |
setProperty(java.lang.String name,
boolean newValue) |
static RaConfigAction |
setProperty(java.lang.String name,
long newValue) |
static RaConfigAction |
setProperty(java.lang.String name,
ObjectGenerator.StringGenerator newValue)
This action sets the value of an RA configuration property.
|
static RaConfigAction |
setProperty(java.lang.String name,
java.lang.String newValue) |
static RaConfigAction |
setPropertyToNull(java.lang.String name)
This is a specialized form of the setProperty action, where the value to be set is null.
|
static Rule[] |
toRulesArray(java.lang.Iterable<Rule> rules)
The toRulesArray() method converts an Iterable object containing rules to the array required by the
API's
rules(com.opencloud.slee.upgrade.transformation.model.RulesContext) method, for cases where it’s easier to build up the rules dynamically. |
public abstract Rule[] rules(RulesContext rulesContext)
rulesContext
- provides access to information on the components included in
the downlevel and the uplevel installations, so that rules
can be tailored to apply to the component versions involved
in the upgrade.public static ObjectGenerator array(ObjectGenerator... values)
public static ObjectGenerator array()
public static ObjectGenerator array(java.lang.String... values)
public static ObjectGenerator array(java.lang.Object... values)
public static StringMatcher anyString()
public static StringMatcher regex(java.lang.String pattern)
public static ComponentMatcher component(java.lang.String name, java.lang.String vendor, java.lang.String version)
regex(java.lang.String)
or anyString()
.public static ComponentMatcher component(java.lang.String name, java.lang.String vendor, StringMatcher version)
for semantics.
public static ComponentMatcher component(java.lang.String name, StringMatcher vendor, java.lang.String version)
for semantics.
public static ComponentMatcher component(java.lang.String name, StringMatcher vendor, StringMatcher version)
for semantics.
public static ComponentMatcher component(StringMatcher name, java.lang.String vendor, java.lang.String version)
for semantics.
public static ComponentMatcher component(StringMatcher name, java.lang.String vendor, StringMatcher version)
for semantics.
public static ComponentMatcher component(StringMatcher name, StringMatcher vendor, java.lang.String version)
for semantics.
public static ComponentMatcher component(StringMatcher name, StringMatcher vendor, StringMatcher version)
for semantics.
public static ProfileRule profileSpec(ComponentMatcher profileSpecId, ProfileRuleChild... children)
component(java.lang.String, java.lang.String, java.lang.String)
or passing the three parameters (name, vendor, and version) directly.profileSpecId
- Identifies the profile specification.children
- Each child is either a nested ProfileRule
, or a ProfileAction
to apply
within the context of this enclosing rule.public static ProfileRule profileSpec(java.lang.String name, java.lang.String vendor, java.lang.String version, ProfileRuleChild... children)
for semantics.
public static ProfileRule profileSpec(java.lang.String name, java.lang.String vendor, StringMatcher version, ProfileRuleChild... children)
for semantics.
public static ProfileRule profileSpec(java.lang.String name, StringMatcher vendor, java.lang.String version, ProfileRuleChild... children)
for semantics.
public static ProfileRule profileSpec(java.lang.String name, StringMatcher vendor, StringMatcher version, ProfileRuleChild... children)
for semantics.
public static ProfileRule profileSpec(StringMatcher name, java.lang.String vendor, java.lang.String version, ProfileRuleChild... children)
for semantics.
public static ProfileRule profileSpec(StringMatcher name, java.lang.String vendor, StringMatcher version, ProfileRuleChild... children)
for semantics.
public static ProfileRule profileSpec(StringMatcher name, StringMatcher vendor, java.lang.String version, ProfileRuleChild... children)
for semantics.
public static ProfileRule profileSpec(StringMatcher name, StringMatcher vendor, StringMatcher version, ProfileRuleChild... children)
for semantics.
public static ProfileRule profileTable(java.lang.String tableName, ProfileRuleChild... children)
regex(java.lang.String)
, anyString()
, or passing the name directly as a String value.profileSpec(com.opencloud.slee.upgrade.transformation.model.ComponentMatcher, com.opencloud.slee.upgrade.transformation.model.ProfileRuleChild...)
context if desired.tableName
- Identifies the profile table name.children
- Each child is either a nested ProfileRule
, or a ProfileAction
to apply
within the context of this enclosing rule.public static ProfileRule profileTable(StringMatcher tableName, ProfileRuleChild... children)
for semantics.
public static ProfileRule profileName(java.lang.String profileName, ProfileRuleChild... children)
regex(java.lang.String)
, anyString()
, or passing the name directly as a String value.profileSpec(com.opencloud.slee.upgrade.transformation.model.ComponentMatcher, com.opencloud.slee.upgrade.transformation.model.ProfileRuleChild...)
or profileTable(java.lang.String, com.opencloud.slee.upgrade.transformation.model.ProfileRuleChild...)
contexts if desired.profileName
- Identities the profile name.children
- Each child is either a nested ProfileRule
, or a ProfileAction
to apply
within the context of this enclosing rule.public static ProfileRule profileName(StringMatcher profileName, ProfileRuleChild... children)
for semantics.
public static ProfileRule ifAttributeValueIsNull(java.lang.String name, ProfileRuleChild... children)
for semantics.
public static ProfileRule ifAttributeValue(java.lang.String name, java.lang.String value, ProfileRuleChild... children)
regex(java.lang.String)
.
name
- The name of the attribute to match.value
- The value to match against.children
- Each child is either a nested ProfileRule
, or a ProfileAction
to apply
within the context of this enclosing rule.public static ProfileRule ifAttributeValue(java.lang.String name, StringMatcher value, ProfileRuleChild... children)
for semantics.
public static ProfileTableCreationRule createTable(java.lang.String tableName, java.lang.String specName, java.lang.String specVendor, java.lang.String specVersion)
tableName
- The name of the profile table to create.specName
- The name of the profile spec used by the profile table.specVendor
- The vendor of the profile spec used by the profile table.specVersion
- The version of the profile spec used by the profile table.public static RaConfigRule raEntity(java.lang.String entityName, RaConfigRuleChild... children)
regex(java.lang.String)
.entityName
- The name of the RA entity to match.children
- Each child is either a nested RaConfigRule
, or a RaConfigAction
to apply
within the context of this enclosing rule.public static RaConfigRule raEntity(StringMatcher entityName, RaConfigRuleChild... children)
for semantics.
public static RaConfigRule ifPropertyValueIsNull(java.lang.String name, RaConfigRuleChild... children)
for semantics.
public static RaConfigRule ifPropertyValue(java.lang.String name, java.lang.String value, RaConfigRuleChild... children)
regex(java.lang.String)
.
name
- The name of the property to match.value
- The value to match against.children
- Each child is either a nested RaConfigRule
, or a RaConfigAction
to apply
within the context of this enclosing rule.public static RaConfigRule ifPropertyValue(java.lang.String name, StringMatcher value, RaConfigRuleChild... children)
for semantics.
public static ProfileAction addAttributeAsNull(java.lang.String name, java.lang.String type)
for semantics.
public static ProfileAction addAttributeAsNull(java.lang.String name, java.lang.String type, @Nullable java.lang.String serialisationVersion)
for semantics.
public static ProfileAction addAttributeAsNull(java.lang.String name, java.lang.Class<?> clazz)
for semantics.
public static ProfileAction addAttribute(java.lang.String name, java.lang.String type, ValueFunction function)
for semantics.
public static ProfileAction addAttribute(java.lang.String name, java.lang.String type, @Nullable java.lang.String serialisationVersion, ValueFunction function)
for semantics.
public static ProfileAction addAttribute(java.lang.String name, java.lang.Class<?> clazz, ValueFunction function)
for semantics.
public static ProfileAction addAttribute(java.lang.String name, java.lang.String type, boolean defaultValue)
for semantics.
public static ProfileAction addAttribute(java.lang.String name, java.lang.Class<?> clazz, boolean defaultValue)
for semantics.
public static ProfileAction addAttribute(java.lang.String name, java.lang.String type, long defaultValue)
for semantics.
public static ProfileAction addAttribute(java.lang.String name, java.lang.Class<?> clazz, long defaultValue)
public static ProfileAction addAttribute(java.lang.String name, java.lang.String type, java.lang.String defaultValue)
for semantics.
public static ProfileAction addAttribute(java.lang.String name, java.lang.String type, @Nullable java.lang.String serialisationVersion, java.lang.String defaultValue)
for semantics.
public static ProfileAction addAttribute(java.lang.String name, java.lang.Class<?> clazz, java.lang.String defaultValue)
for semantics.
public static ProfileAction addAttribute(java.lang.String name, java.lang.Class<?> clazz, ObjectGenerator defaultValue)
for semantics.
public static ProfileAction addAttribute(java.lang.String name, java.lang.String type, ObjectGenerator defaultValue)
name
- The name of the attribute.type
- The type of the attribute, expressed as a fully qualified Java class name.defaultValue
- The value to use if a value isn't already present in the export, and if no more specific value
is set elsewhere.public static ProfileAction addAttribute(java.lang.String name, java.lang.String type, @Nullable java.lang.String serialisationVersion, ObjectGenerator defaultValue)
name
- The name of the attribute.type
- The type of the attribute, expressed as a fully qualified Java class name.serialisationVersion
- The serialisation-version to use in the profile export XML.defaultValue
- The value to use if a value isn't already present in the export, and if no more specific value
is set elsewhere.public static ProfileAction doNotImportAttribute(@Nonnull java.lang.String name)
name
- The name of the attribute to remove from the export data.public static ProfileAction setAttributeToNull(@Nonnull java.lang.String name)
for semantics.
public static ProfileAction setAttribute(@Nonnull java.lang.String name, ValueFunction function)
for semantics.
public static ProfileAction setAttribute(@Nonnull java.lang.String name, boolean newValue)
for semantics.
public static ProfileAction setAttribute(@Nonnull java.lang.String name, long newValue)
for semantics.
public static ProfileAction setAttribute(@Nonnull java.lang.String name, java.lang.Object[] newValue)
for semantics.
public static ProfileAction setAttribute(@Nonnull java.lang.String name, int[] newValue)
for semantics.
public static ProfileAction setAttribute(@Nonnull java.lang.String name, long[] newValue)
for semantics.
public static ProfileAction setAttribute(@Nonnull java.lang.String name, java.lang.String newValue)
for semantics.
public static ProfileAction setAttribute(@Nonnull java.lang.String name, @Nonnull ObjectGenerator newValue)
addAttribute(String, String, ValueFunction)
, the value can also be passed
via a ValueFunction object, which allows the value to be calculated when the rule is actually applied.name
- The name of the attribute to set.newValue
- The new value to set the attribute to.public static ProfileAction renameAttribute(@Nonnull java.lang.String originalName, @Nonnull java.lang.String newName)
originalName
- The original name of the attribute.newName
- The new name to use for the attribute.public static ProfileAction changeAttributeType(@Nonnull java.lang.String name, @Nonnull java.lang.String newType)
name
- The name of the attribute to change.newType
- The new type to use for the attribute, as a fully qualified Java class name.public static ProfileAction changeAttributeType(@Nonnull java.lang.String name, @Nonnull java.lang.Class<?> clazz)
for semantics.
public static ProfileAction createProfile(@Nonnull java.lang.String name)
name
- The name of the profile to create.public static ProfileAction doNotImportProfile()
public static ProfileAction doNotImportProfileTable()
public static ProfileAction renameProfile(@Nonnull java.lang.String newName)
for semantics.
public static ProfileAction renameProfile(@Nonnull ValueFunction newName)
newName
- The new name to use for the profile.public static ProfileAction renameProfileTable(@Nonnull java.lang.String newName)
newName
- The new name to use for the profile table.public static ProfileAction renameProfileSpec(@Nonnull java.lang.String newName)
newName
- The new name for the profile spec.public static RaConfigAction addPropertyAsNull(@Nonnull java.lang.String name, java.lang.Class<?> clazz)
for semantics.
public static RaConfigAction addPropertyAsNull(@Nonnull java.lang.String name, @Nonnull java.lang.String type)
for semantics.
public static RaConfigAction addProperty(@Nonnull java.lang.String name, java.lang.Class<?> clazz, boolean defaultValue)
for semantics.
public static RaConfigAction addProperty(@Nonnull java.lang.String name, @Nonnull java.lang.String type, boolean defaultValue)
for semantics.
public static RaConfigAction addProperty(@Nonnull java.lang.String name, java.lang.Class<?> clazz, long defaultValue)
for semantics.
public static RaConfigAction addProperty(@Nonnull java.lang.String name, @Nonnull java.lang.String type, long defaultValue)
for semantics.
public static RaConfigAction addProperty(@Nonnull java.lang.String name, @Nonnull java.lang.String type, @Nonnull java.lang.String defaultValue)
for semantics.
public static RaConfigAction addProperty(@Nonnull java.lang.String name, @Nonnull java.lang.Class<?> clazz, @Nonnull java.lang.String defaultValue)
for semantics.
public static RaConfigAction addProperty(@Nonnull java.lang.String name, @Nonnull java.lang.Class<?> clazz, @Nonnull ObjectGenerator.StringGenerator defaultValue)
for semantics.
public static RaConfigAction addProperty(@Nonnull java.lang.String name, @Nonnull java.lang.String type, @Nonnull ObjectGenerator.StringGenerator defaultValue)
name
- The name of the RA configuration property to add.type
- The type of the RA configuration property, as a fully qualified Java class name.defaultValue
- The value to use when no other value is provided,
and when the property is not already set in the export data.public static RaConfigAction doNotImportProperty(@Nonnull java.lang.String name)
name
- The name of the configuration property to delete.public static RaConfigAction setPropertyToNull(@Nonnull java.lang.String name)
for semantics.
public static RaConfigAction setProperty(@Nonnull java.lang.String name, boolean newValue)
for semantics.
public static RaConfigAction setProperty(@Nonnull java.lang.String name, long newValue)
for semantics.
public static RaConfigAction setProperty(@Nonnull java.lang.String name, @Nonnull java.lang.String newValue)
for semantics.
public static RaConfigAction setProperty(@Nonnull java.lang.String name, @Nonnull ObjectGenerator.StringGenerator newValue)
name
- The name of the RA configuration property.newValue
- The new value to set the configuration property to.public static RaConfigAction renameProperty(@Nonnull java.lang.String originalName, @Nonnull java.lang.String newName)
originalName
- The original name of the property.newName
- The new name to use for the property.public static RaConfigAction doNotImportRaEntity()
public static RaConfigAction renameRaEntity(@Nonnull java.lang.String newName)
newName
- The new name to use for the RA entity.public static Rule[] toRulesArray(java.lang.Iterable<Rule> rules)
rules(com.opencloud.slee.upgrade.transformation.model.RulesContext)
method, for cases where it’s easier to build up the rules dynamically.@Nullable public java.lang.String getRaProperty(@Nonnull java.lang.String entityName, @Nonnull java.lang.String propertyName)
entityName
- The name of the RA entity to query.propertyName
- The name of the RA configuration property to query.@Nullable public java.lang.String getUplevelRaProperty(@Nonnull java.lang.String entityName, @Nonnull java.lang.String propertyName)
entityName
- The name of the RA entity to query.propertyName
- The name of the RA configuration property to query.@Nullable public java.lang.String getProfileAttribute(@Nonnull java.lang.String profileTable, @Nonnull java.lang.String profileName, @Nonnull java.lang.String attributeName)
getProfileAttributeArray(String, String, String)
,
which has a return type which can correctly express the array contents.profileTable
- The name of the profile table to query.profileName
- The name of the profile to query.attributeName
- The name of the profile attribute to query.@Nullable public java.lang.String getUplevelProfileAttribute(@Nonnull java.lang.String profileTable, @Nonnull java.lang.String profileName, @Nonnull java.lang.String attributeName)
getUplevelProfileAttributeArray(String, String, String)
,
which has a return type which can correctly express the array contents.profileTable
- The name of the profile table to query.profileName
- The name of the profile to query.attributeName
- The name of the profile attribute to query.@Nullable public java.lang.String[] getProfileAttributeArray(@Nonnull java.lang.String profileTable, @Nonnull java.lang.String profileName, @Nonnull java.lang.String attributeName)
getProfileAttribute(String, String, String)
,
which has a return type that can correctly express the simple contents.profileTable
- The name of the profile table to query.profileName
- The name of the profile to query.attributeName
- The name of the profile attribute to query.@Nullable public java.lang.String[] getUplevelProfileAttributeArray(@Nonnull java.lang.String profileTable, @Nonnull java.lang.String profileName, @Nonnull java.lang.String attributeName)
getUplevelProfileAttribute(String, String, String)
,
which has a return type that can correctly express the simple contentsprofileTable
- The name of the profile table to query.profileName
- The name of the profile to query.attributeName
- The name of the profile attribute to query.public java.lang.String[] getProfileNames(java.lang.String profileTable)
public java.lang.String[] getUplevelProfileNames(java.lang.String profileTable)
public void issueWarning(java.lang.String message)
message
- The warning message to issue.public static ValueFunction functionArrayAppend(java.lang.String... values)
values
- The values to append to the array.public static ValueFunction functionArrayAddUniqueValues(java.lang.String... values)
values
- The values to add to the array.public static ValueFunction functionArrayRemove(java.lang.String... values)
values
- The values to remove from the array.List.removeAll(Collection)
public ValueFunction functionUplevelProfileAttribute()
public ValueFunction functionUplevelProfileAttributeArray()
public static ValueFunction functionForDefaultProfileAndOthers(@Nonnull ValueFunction valueForDefaultProfile, @Nonnull ValueFunction valueForNonDefaultProfiles)
valueForDefaultProfile
- The value to use when editing the default profile.
(the profile whose name is the empty string).valueForNonDefaultProfiles
- The value to use when editing any profile other than the default profile.public static ValueFunction functionForDefaultProfileAndOthers(java.lang.String valueForDefaultProfile, java.lang.String valueForNonDefaultProfiles)
for semantics.
public static ValueFunction functionForDefaultProfileAndOthers(java.lang.String valueForDefaultProfile, ValueFunction valueForNonDefaultProfiles)
for semantics.
public static ValueFunction functionForDefaultProfileAndOthers(ValueFunction valueForDefaultProfile, java.lang.String valueForNonDefaultProfiles)
for semantics.
public static ValueFunction functionForConstant(@Nullable java.lang.Object value)
public void setEnvironment(java.util.List<org.w3c.dom.Document> documents, com.opencloud.slee.data.migration.ExportData exportData, java.util.List<org.w3c.dom.Document> uplevelDocuments, com.opencloud.slee.data.migration.ExportData uplevelData)
public void setProblemCollector(ProblemCollector problemCollector)
Copyright © OpenCloud. All Rights Reserved.