TPTP 4.5.0 Platform Project
Internal API Specification

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

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Implementing Classes:
RuleElementTypeImpl

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

A representation of the model object 'Rule Element Type'. RuleElementTypes are meta descriptors for any structured types. The structured type must have a name and it contains an optional set of attributes. Structured types may be nested under other structured types.

The following features are supported:

See Also:
ParserPackage.getRuleElementType()
Generated
[EMF] Model
extendedMetaData="name='RuleElementType' kind='elementOnly'"

Method Summary
 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 getRuleAttribute()
          Returns the value of the 'Rule Attribute' containment reference list.
 org.eclipse.emf.common.util.EList getRuleElement()
          Returns the value of the 'Rule Element' containment reference list.
 boolean isIsChildChoice()
          Returns the value of the 'Is Child Choice' attribute.
 boolean isIsRequiredByParent()
          Returns the value of the 'Is Required By Parent' attribute.
 boolean isSetIsChildChoice()
          Returns whether the value of the 'Is Child Choice' attribute is set
 boolean isSetIsRequiredByParent()
          Returns whether the value of the 'Is Required By Parent' attribute is set
 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 setIsChildChoice(boolean value)
          Sets the value of the 'Is Child Choice' 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 unsetIsChildChoice()
          Unsets the value of the 'Is Child Choice' attribute
 void unsetIsRequiredByParent()
          Unsets the value of the 'Is Required By Parent' 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

getRuleElement

org.eclipse.emf.common.util.EList getRuleElement()
Returns the value of the 'Rule Element' containment reference list. The list contents are of type RuleElementType.

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

Returns:
the value of the 'Rule Element' containment reference list.
See Also:
ParserPackage.getRuleElementType_RuleElement()
Generated
[EMF] Model
type="org.eclipse.hyades.logging.adapter.model.internal.parser.RuleElementType" containment="true" extendedMetaData="kind='element' name='RuleElement' namespace='##targetNamespace'"

getRuleAttribute

org.eclipse.emf.common.util.EList getRuleAttribute()
Returns the value of the 'Rule Attribute' containment reference list. The list contents are of type RuleAttributeType.

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

Returns:
the value of the 'Rule Attribute' containment reference list.
See Also:
ParserPackage.getRuleElementType_RuleAttribute()
Generated
[EMF] Model
type="org.eclipse.hyades.logging.adapter.model.internal.parser.RuleAttributeType" containment="true" extendedMetaData="kind='element' name='RuleAttribute' namespace='##targetNamespace'"

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 element.

Returns:
the value of the 'Id' attribute.
See Also:
setId(BigInteger), ParserPackage.getRuleElementType_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 element.

Returns:
the value of the 'Index' attribute.
See Also:
setIndex(String), ParserPackage.getRuleElementType_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

isIsChildChoice

boolean isIsChildChoice()
Returns the value of the 'Is Child Choice' attribute. The default value is "false".

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

This attribute indicates whether only one of this structured type's children can be included in the parsing result.

Returns:
the value of the 'Is Child Choice' attribute.
See Also:
isSetIsChildChoice(), unsetIsChildChoice(), setIsChildChoice(boolean), ParserPackage.getRuleElementType_IsChildChoice()
Generated
[EMF] Model
default="false" unique="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.Boolean" extendedMetaData="kind='attribute' name='isChildChoice'"

setIsChildChoice

void setIsChildChoice(boolean value)
Sets the value of the 'Is Child Choice' attribute.

Parameters:
value - the new value of the 'Is Child Choice' attribute.
See Also:
isSetIsChildChoice(), unsetIsChildChoice(), isIsChildChoice()
Generated

unsetIsChildChoice

void unsetIsChildChoice()
Unsets the value of the 'Is Child Choice' attribute.

See Also:
isSetIsChildChoice(), isIsChildChoice(), setIsChildChoice(boolean)
Generated

isSetIsChildChoice

boolean isSetIsChildChoice()
Returns whether the value of the 'Is Child Choice' attribute is set.

Returns:
whether the value of the 'Is Child Choice' attribute is set.
See Also:
unsetIsChildChoice(), isIsChildChoice(), setIsChildChoice(boolean)
Generated

isIsRequiredByParent

boolean isIsRequiredByParent()
Returns the value of the 'Is Required By Parent' attribute. The default value is "false".

If the meaning of the 'Is Required By Parent' attribute isn't clear, there really should be more of a description here...

This attribute indicates whether a value for this structured type is required by its parent structured type.

Returns:
the value of the 'Is Required By Parent' attribute.
See Also:
isSetIsRequiredByParent(), unsetIsRequiredByParent(), setIsRequiredByParent(boolean), ParserPackage.getRuleElementType_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 structured type this rule element represents. For example: CommonBaseEvent.

Returns:
the value of the 'Name' attribute.
See Also:
setName(String), ParserPackage.getRuleElementType_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

TPTP 4.5.0 Platform Project
Internal API Specification