org.eclipse.hyades.logging.adapter.model.internal.parser
Interface RuleAttributeType

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

RuleAttributeTypeImpl

public interface RuleAttributeType
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Rule Attribute Type'. RuleAttributeTypes describe the attributes of a structured type. Attributes have a name and a value as well as a set of rules that are used to create a value for the attribute.

The following features are supported:

• Substitution Rule
• Default Value
• Id
• Index
• Is Required By Parent
• Name
• Use Previous Match Substitution As Default

See Also:

ParserPackage.getRuleAttributeType()

Generated

[EMF] Model

extendedMetaData="name='RuleAttributeType' kind='elementOnly'"

Method Summary

java.lang.String	getDefaultValue() Returns the value of the 'Default Value' attribute
java.math.BigInteger	getId() Returns the value of the 'Id' attribute
java.lang.String	getIndex() Returns the value of the 'Index' attribute
java.lang.String	getName() Returns the value of the 'Name' attribute
org.eclipse.emf.common.util.EList	getSubstitutionRule() Returns the value of the 'Substitution Rule' containment reference list.
boolean	isIsRequiredByParent() Returns the value of the 'Is Required By Parent' attribute.
boolean	isSetIsRequiredByParent() Returns whether the value of the 'Is Required By Parent' attribute is set
boolean	isSetUsePreviousMatchSubstitutionAsDefault() Returns whether the value of the 'Use Previous Match Substitution As Default' attribute is set
boolean	isUsePreviousMatchSubstitutionAsDefault() Returns the value of the 'Use Previous Match Substitution As Default' attribute
void	setDefaultValue(java.lang.String value) Sets the value of the 'Default Value' attribute
void	setId(java.math.BigInteger value) Sets the value of the 'Id' attribute
void	setIndex(java.lang.String value) Sets the value of the 'Index' attribute
void	setIsRequiredByParent(boolean value) Sets the value of the 'Is Required By Parent' attribute
void	setName(java.lang.String value) Sets the value of the 'Name' attribute
void	setUsePreviousMatchSubstitutionAsDefault(boolean value) Sets the value of the 'Use Previous Match Substitution As Default' attribute
void	unsetIsRequiredByParent() Unsets the value of the 'Is Required By Parent' attribute
void	unsetUsePreviousMatchSubstitutionAsDefault() Unsets the value of the 'Use Previous Match Substitution As Default' attribute

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getSubstitutionRule

org.eclipse.emf.common.util.EList getSubstitutionRule()

Returns the value of the 'Substitution Rule' containment reference list. The list contents are of type SubstitutionRuleType.

If the meaning of the 'Substitution Rule' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Substitution Rule' containment reference list.

See Also:

ParserPackage.getRuleAttributeType_SubstitutionRule()

Generated

[EMF] Model

type="org.eclipse.hyades.logging.adapter.model.internal.parser.SubstitutionRuleType" containment="true" extendedMetaData="kind='element' name='SubstitutionRule'"

getDefaultValue

java.lang.String getDefaultValue()

Returns the value of the 'Default Value' attribute. An optional specification of a default value to be returned if there is no substitution rule or no successful substitution rules.

Returns:

the value of the 'Default Value' attribute.

See Also:

setDefaultValue(String), ParserPackage.getRuleAttributeType_DefaultValue()

Generated

[EMF] Model

unique="false" dataType="org.eclipse.emf.ecore.xml.type.String" extendedMetaData="kind='attribute' name='defaultValue'"

setDefaultValue

void setDefaultValue(java.lang.String value)

Sets the value of the 'Default Value' attribute.

Parameters:

value - the new value of the 'Default Value' attribute.

See Also:

getDefaultValue()

Generated

getId

java.math.BigInteger getId()

Returns the value of the 'Id' attribute.

If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...

An ID number for this rule attribute.

Returns:

the value of the 'Id' attribute.

See Also:

setId(BigInteger), ParserPackage.getRuleAttributeType_Id()

Generated

[EMF] Model

unique="false" dataType="org.eclipse.emf.ecore.xml.type.Integer" extendedMetaData="kind='attribute' name='id'"

setId

void setId(java.math.BigInteger value)

Sets the value of the 'Id' attribute.

Parameters:

value - the new value of the 'Id' attribute.

See Also:

getId()

Generated

getIndex

java.lang.String getIndex()

Returns the value of the 'Index' attribute.

If the meaning of the 'Index' attribute isn't clear, there really should be more of a description here...

An unique index for this rule attribute.

Returns:

the value of the 'Index' attribute.

See Also:

setIndex(String), ParserPackage.getRuleAttributeType_Index()

Generated

[EMF] Model

unique="false" dataType="org.eclipse.emf.ecore.xml.type.String" extendedMetaData="kind='attribute' name='index'"

setIndex

void setIndex(java.lang.String value)

Sets the value of the 'Index' attribute.

Parameters:

value - the new value of the 'Index' attribute.

See Also:

getIndex()

Generated

isIsRequiredByParent

boolean isIsRequiredByParent()

Returns the value of the 'Is Required By Parent' attribute. The default value is "false". A boolean indicator of whether this RuleAttribute must produce a valid value in order for the parent RuleElement to be considered valid.

Returns:

the value of the 'Is Required By Parent' attribute.

See Also:

isSetIsRequiredByParent(), unsetIsRequiredByParent(), setIsRequiredByParent(boolean), ParserPackage.getRuleAttributeType_IsRequiredByParent()

Generated

[EMF] Model

default="false" unique="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.Boolean" extendedMetaData="kind='attribute' name='isRequiredByParent'"

setIsRequiredByParent

void setIsRequiredByParent(boolean value)

Sets the value of the 'Is Required By Parent' attribute.

Parameters:

value - the new value of the 'Is Required By Parent' attribute.

See Also:

isSetIsRequiredByParent(), unsetIsRequiredByParent(), isIsRequiredByParent()

Generated

unsetIsRequiredByParent

void unsetIsRequiredByParent()

Unsets the value of the 'Is Required By Parent' attribute.

See Also:

isSetIsRequiredByParent(), isIsRequiredByParent(), setIsRequiredByParent(boolean)

Generated

isSetIsRequiredByParent

boolean isSetIsRequiredByParent()

Returns whether the value of the 'Is Required By Parent' attribute is set.

Returns:

whether the value of the 'Is Required By Parent' attribute is set.

See Also:

unsetIsRequiredByParent(), isIsRequiredByParent(), setIsRequiredByParent(boolean)

Generated

getName

java.lang.String getName()

Returns the value of the 'Name' attribute.

If the meaning of the 'Name' attribute isn't clear, there really should be more of a description here...

The name of the attribute of the structured type this rule attribute represents. For example: creationTIme.

Returns:

the value of the 'Name' attribute.

See Also:

setName(String), ParserPackage.getRuleAttributeType_Name()

Generated

[EMF] Model

unique="false" dataType="org.eclipse.emf.ecore.xml.type.String" required="true" extendedMetaData="kind='attribute' name='name'"

setName

void setName(java.lang.String value)

Sets the value of the 'Name' attribute.

Parameters:

value - the new value of the 'Name' attribute.

See Also:

getName()

Generated

isUsePreviousMatchSubstitutionAsDefault

boolean isUsePreviousMatchSubstitutionAsDefault()

Returns the value of the 'Use Previous Match Substitution As Default' attribute. A boolean indicator of whether a previously parsed value be returned if no substitution rules are successful.

Returns:

the value of the 'Use Previous Match Substitution As Default' attribute.

See Also:

isSetUsePreviousMatchSubstitutionAsDefault(), unsetUsePreviousMatchSubstitutionAsDefault(), setUsePreviousMatchSubstitutionAsDefault(boolean), ParserPackage.getRuleAttributeType_UsePreviousMatchSubstitutionAsDefault()

Generated

[EMF] Model

unique="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.Boolean" extendedMetaData="kind='attribute' name='usePreviousMatchSubstitutionAsDefault'"

setUsePreviousMatchSubstitutionAsDefault

void setUsePreviousMatchSubstitutionAsDefault(boolean value)

Sets the value of the 'Use Previous Match Substitution As Default' attribute.

Parameters:

value - the new value of the 'Use Previous Match Substitution As Default' attribute.

See Also:

isSetUsePreviousMatchSubstitutionAsDefault(), unsetUsePreviousMatchSubstitutionAsDefault(), isUsePreviousMatchSubstitutionAsDefault()

Generated

unsetUsePreviousMatchSubstitutionAsDefault

void unsetUsePreviousMatchSubstitutionAsDefault()

Unsets the value of the 'Use Previous Match Substitution As Default' attribute.

See Also:

isSetUsePreviousMatchSubstitutionAsDefault(), isUsePreviousMatchSubstitutionAsDefault(), setUsePreviousMatchSubstitutionAsDefault(boolean)

Generated

isSetUsePreviousMatchSubstitutionAsDefault

boolean isSetUsePreviousMatchSubstitutionAsDefault()

Returns whether the value of the 'Use Previous Match Substitution As Default' attribute is set.

Returns:

whether the value of the 'Use Previous Match Substitution As Default' attribute is set.

See Also:

unsetUsePreviousMatchSubstitutionAsDefault(), isUsePreviousMatchSubstitutionAsDefault(), setUsePreviousMatchSubstitutionAsDefault(boolean)

Generated