|
TPTP 4.6.0 Platform Project Internal API Specification |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ContextInstanceType
A representation of the model object 'Context Instance Type'. A context instance has a set of properties that are common to every context when it is running. It also contains a variety of components or "processing units" including at least one sensor which is always needed to start the sequence. The components are executed in the order they are declared, and this order has to match the context configuration file.
The following features are supported:
SensorExtractorParserProcess UnitFormatterFilterOutputterCharsetContinuous OperationDayDescriptionDisabledEnable ICUIso Country CodeIso Language CodeMaximum Idle TimeMonthPause IntervalTimezoneUnique IDYear
ConfigurationPackage.getContextInstanceType()| Method Summary | |
|---|---|
java.lang.String |
getCharset()
Returns the value of the 'Charset' attribute. |
java.math.BigInteger |
getDay()
Returns the value of the 'Day' attribute |
java.lang.String |
getDescription()
Returns the value of the 'Description' attribute |
ExtractorType |
getExtractor()
Returns the value of the 'Extractor' containment reference |
org.eclipse.emf.common.util.EList |
getFilter()
Returns the value of the 'Filter' containment reference list. |
org.eclipse.emf.common.util.EList |
getFormatter()
Returns the value of the 'Formatter' containment reference list. |
java.lang.String |
getIsoCountryCode()
Returns the value of the 'Iso Country Code' attribute. |
java.lang.String |
getIsoLanguageCode()
Returns the value of the 'Iso Language Code' attribute. |
java.lang.String |
getMaximumIdleTime()
Returns the value of the 'Maximum Idle Time' attribute |
java.math.BigInteger |
getMonth()
Returns the value of the 'Month' attribute |
org.eclipse.emf.common.util.EList |
getOutputter()
Returns the value of the 'Outputter' containment reference list. |
ParserConfigType |
getParser()
Returns the value of the 'Parser' containment reference |
java.lang.String |
getPauseInterval()
Returns the value of the 'Pause Interval' attribute |
org.eclipse.emf.common.util.EList |
getProcessUnit()
Returns the value of the 'Process Unit' containment reference list. |
SensorConfigType |
getSensor()
Returns the value of the 'Sensor' containment reference |
java.lang.String |
getTimezone()
Returns the value of the 'Timezone' attribute |
java.lang.String |
getUniqueID()
Returns the value of the 'Unique ID' attribute |
java.math.BigInteger |
getYear()
Returns the value of the 'Year' attribute |
boolean |
isContinuousOperation()
Returns the value of the 'Continuous Operation' attribute |
boolean |
isDisabled()
Returns the value of the 'Disabled' attribute |
boolean |
isEnableICU()
Returns the value of the 'Enable ICU' attribute |
boolean |
isSetCharset()
Returns whether the value of the ' Charset' attribute is set |
boolean |
isSetContinuousOperation()
Returns whether the value of the ' Continuous Operation' attribute is set |
boolean |
isSetDisabled()
Returns whether the value of the ' Disabled' attribute is set |
boolean |
isSetEnableICU()
Returns whether the value of the ' Enable ICU' attribute is set |
boolean |
isSetIsoCountryCode()
Returns whether the value of the ' Iso Country Code' attribute is set |
boolean |
isSetIsoLanguageCode()
Returns whether the value of the ' Iso Language Code' attribute is set |
void |
setCharset(java.lang.String value)
Sets the value of the ' Charset' attribute |
void |
setContinuousOperation(boolean value)
Sets the value of the ' Continuous Operation' attribute |
void |
setDay(java.math.BigInteger value)
Sets the value of the ' Day' attribute |
void |
setDescription(java.lang.String value)
Sets the value of the ' Description' attribute |
void |
setDisabled(boolean value)
Sets the value of the ' Disabled' attribute |
void |
setEnableICU(boolean value)
Sets the value of the ' Enable ICU' attribute |
void |
setExtractor(ExtractorType value)
Sets the value of the ' Extractor' containment reference |
void |
setIsoCountryCode(java.lang.String value)
Sets the value of the ' Iso Country Code' attribute |
void |
setIsoLanguageCode(java.lang.String value)
Sets the value of the ' Iso Language Code' attribute |
void |
setMaximumIdleTime(java.lang.String value)
Sets the value of the ' Maximum Idle Time' attribute |
void |
setMonth(java.math.BigInteger value)
Sets the value of the ' Month' attribute |
void |
setParser(ParserConfigType value)
Sets the value of the ' Parser' containment reference |
void |
setPauseInterval(java.lang.String value)
Sets the value of the ' Pause Interval' attribute |
void |
setSensor(SensorConfigType value)
Sets the value of the ' Sensor' containment reference |
void |
setTimezone(java.lang.String value)
Sets the value of the ' Timezone' attribute |
void |
setUniqueID(java.lang.String value)
Sets the value of the ' Unique ID' attribute |
void |
setYear(java.math.BigInteger value)
Sets the value of the ' Year' attribute |
void |
unsetCharset()
Unsets the value of the ' Charset' attribute |
void |
unsetContinuousOperation()
Unsets the value of the ' Continuous Operation' attribute |
void |
unsetDisabled()
Unsets the value of the ' Disabled' attribute |
void |
unsetEnableICU()
Unsets the value of the ' Enable ICU' attribute |
void |
unsetIsoCountryCode()
Unsets the value of the ' Iso Country Code' attribute |
void |
unsetIsoLanguageCode()
Unsets the value of the ' Iso Language Code' 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 |
|---|
SensorConfigType getSensor()
If the meaning of the 'Sensor' containment reference isn't clear, there really should be more of a description here...
setSensor(SensorConfigType),
ConfigurationPackage.getContextInstanceType_Sensor()void setSensor(SensorConfigType value)
Sensor' containment reference.
value - the new value of the 'Sensor' containment reference.getSensor()ExtractorType getExtractor()
If the meaning of the 'Extractor' containment reference isn't clear, there really should be more of a description here...
setExtractor(ExtractorType),
ConfigurationPackage.getContextInstanceType_Extractor()void setExtractor(ExtractorType value)
Extractor' containment reference.
value - the new value of the 'Extractor' containment reference.getExtractor()ParserConfigType getParser()
If the meaning of the 'Parser' containment reference isn't clear, there really should be more of a description here...
setParser(ParserConfigType),
ConfigurationPackage.getContextInstanceType_Parser()void setParser(ParserConfigType value)
Parser' containment reference.
value - the new value of the 'Parser' containment reference.getParser()org.eclipse.emf.common.util.EList getProcessUnit()
ProcessUnitType.
If the meaning of the 'Process Unit' containment reference list isn't clear, there really should be more of a description here...
A Process Unit is the most basic component of execution in a context. It is provided as an abstract component and for the development of custom components that do not conform to any of the other defined component types.
ConfigurationPackage.getContextInstanceType_ProcessUnit()org.eclipse.emf.common.util.EList getFormatter()
FormatterType.
If the meaning of the 'Formatter' containment reference list isn't clear, there really should be more of a description here...
ConfigurationPackage.getContextInstanceType_Formatter()org.eclipse.emf.common.util.EList getFilter()
FilterConfigType.
If the meaning of the 'Filter' containment reference list isn't clear, there really should be more of a description here...
This is the root element for the filter component. All the filter rules are hierarchically arranged under this element.
ConfigurationPackage.getContextInstanceType_Filter()org.eclipse.emf.common.util.EList getOutputter()
OutputterConfigType.
If the meaning of the 'Outputter' containment reference list isn't clear, there really should be more of a description here...
ConfigurationPackage.getContextInstanceType_Outputter()java.lang.String getCharset()
"UTF-8".
If the meaning of the 'Charset' attribute isn't clear, there really should be more of a description here...
This attribute defines the encoding of the log file that is used to read the log file.
isSetCharset(),
unsetCharset(),
setCharset(String),
ConfigurationPackage.getContextInstanceType_Charset()void setCharset(java.lang.String value)
Charset' attribute.
value - the new value of the 'Charset' attribute.isSetCharset(),
unsetCharset(),
getCharset()void unsetCharset()
Charset' attribute.
isSetCharset(),
getCharset(),
setCharset(String)boolean isSetCharset()
Charset' attribute is set.
unsetCharset(),
getCharset(),
setCharset(String)boolean isContinuousOperation()
isSetContinuousOperation(),
unsetContinuousOperation(),
setContinuousOperation(boolean),
ConfigurationPackage.getContextInstanceType_ContinuousOperation()void setContinuousOperation(boolean value)
Continuous Operation' attribute.
value - the new value of the 'Continuous Operation' attribute.isSetContinuousOperation(),
unsetContinuousOperation(),
isContinuousOperation()void unsetContinuousOperation()
Continuous Operation' attribute.
isSetContinuousOperation(),
isContinuousOperation(),
setContinuousOperation(boolean)boolean isSetContinuousOperation()
Continuous Operation' attribute is set.
unsetContinuousOperation(),
isContinuousOperation(),
setContinuousOperation(boolean)java.math.BigInteger getDay()
setDay(BigInteger),
ConfigurationPackage.getContextInstanceType_Day()void setDay(java.math.BigInteger value)
Day' attribute.
value - the new value of the 'Day' attribute.getDay()java.lang.String getDescription()
If the meaning of the 'Description' attribute isn't clear, there really should be more of a description here...
setDescription(String),
ConfigurationPackage.getContextInstanceType_Description()void setDescription(java.lang.String value)
Description' attribute.
value - the new value of the 'Description' attribute.getDescription()boolean isDisabled()
If the meaning of the 'Disabled' attribute isn't clear, there really should be more of a description here...
isSetDisabled(),
unsetDisabled(),
setDisabled(boolean),
ConfigurationPackage.getContextInstanceType_Disabled()void setDisabled(boolean value)
Disabled' attribute.
value - the new value of the 'Disabled' attribute.isSetDisabled(),
unsetDisabled(),
isDisabled()void unsetDisabled()
Disabled' attribute.
isSetDisabled(),
isDisabled(),
setDisabled(boolean)boolean isSetDisabled()
Disabled' attribute is set.
unsetDisabled(),
isDisabled(),
setDisabled(boolean)boolean isEnableICU()
isSetEnableICU(),
unsetEnableICU(),
setEnableICU(boolean),
ConfigurationPackage.getContextInstanceType_EnableICU()void setEnableICU(boolean value)
Enable ICU' attribute.
value - the new value of the 'Enable ICU' attribute.isSetEnableICU(),
unsetEnableICU(),
isEnableICU()void unsetEnableICU()
Enable ICU' attribute.
isSetEnableICU(),
isEnableICU(),
setEnableICU(boolean)boolean isSetEnableICU()
Enable ICU' attribute is set.
unsetEnableICU(),
isEnableICU(),
setEnableICU(boolean)java.lang.String getIsoCountryCode()
"US".
If the meaning of the 'Iso Country Code' attribute isn't clear, there really should be more of a description here...
This attribute defines the ISO two letter Country Code to use to parse the log file. It is used along with the isoLanguageCode value to determine the locale to use to parse the log file.
isSetIsoCountryCode(),
unsetIsoCountryCode(),
setIsoCountryCode(String),
ConfigurationPackage.getContextInstanceType_IsoCountryCode()void setIsoCountryCode(java.lang.String value)
Iso Country Code' attribute.
value - the new value of the 'Iso Country Code' attribute.isSetIsoCountryCode(),
unsetIsoCountryCode(),
getIsoCountryCode()void unsetIsoCountryCode()
Iso Country Code' attribute.
isSetIsoCountryCode(),
getIsoCountryCode(),
setIsoCountryCode(String)boolean isSetIsoCountryCode()
Iso Country Code' attribute is set.
unsetIsoCountryCode(),
getIsoCountryCode(),
setIsoCountryCode(String)java.lang.String getIsoLanguageCode()
"en".
If the meaning of the 'Iso Language Code' attribute isn't clear, there really should be more of a description here...
This attribute defines the ISO two letter Language Code to use to parse the log file. It is used along with the isoCountryCode value to determine the locale to use to parse the log file.
isSetIsoLanguageCode(),
unsetIsoLanguageCode(),
setIsoLanguageCode(String),
ConfigurationPackage.getContextInstanceType_IsoLanguageCode()void setIsoLanguageCode(java.lang.String value)
Iso Language Code' attribute.
value - the new value of the 'Iso Language Code' attribute.isSetIsoLanguageCode(),
unsetIsoLanguageCode(),
getIsoLanguageCode()void unsetIsoLanguageCode()
Iso Language Code' attribute.
isSetIsoLanguageCode(),
getIsoLanguageCode(),
setIsoLanguageCode(String)boolean isSetIsoLanguageCode()
Iso Language Code' attribute is set.
unsetIsoLanguageCode(),
getIsoLanguageCode(),
setIsoLanguageCode(String)java.lang.String getMaximumIdleTime()
If the meaning of the 'Maximum Idle Time' attribute isn't clear, there really should be more of a description here...
This attribute is only used when continuousOperation is true. Maximum idle time means how long the context will run with no input, hence idle. A maximum idle time of zero means run forever. Any other time is a maximum amount of time the context will wait for more input. Once no input has been detected the context will pause before attempting to determine if there is more input. The pause time is defined by the pauseInterval attribute.
setMaximumIdleTime(String),
ConfigurationPackage.getContextInstanceType_MaximumIdleTime()void setMaximumIdleTime(java.lang.String value)
Maximum Idle Time' attribute.
value - the new value of the 'Maximum Idle Time' attribute.getMaximumIdleTime()java.math.BigInteger getMonth()
setMonth(BigInteger),
ConfigurationPackage.getContextInstanceType_Month()void setMonth(java.math.BigInteger value)
Month' attribute.
value - the new value of the 'Month' attribute.getMonth()java.lang.String getPauseInterval()
If the meaning of the 'Pause Interval' attribute isn't clear, there really should be more of a description here...
This attribute is only used when continuousOperation is true. Once no input has been detected by the context, the context will pause before attempting to determine if there is more input. The amount of time the context will pause is set with this attribute.
setPauseInterval(String),
ConfigurationPackage.getContextInstanceType_PauseInterval()void setPauseInterval(java.lang.String value)
Pause Interval' attribute.
value - the new value of the 'Pause Interval' attribute.getPauseInterval()java.lang.String getTimezone()
setTimezone(String),
ConfigurationPackage.getContextInstanceType_Timezone()void setTimezone(java.lang.String value)
Timezone' attribute.
value - the new value of the 'Timezone' attribute.getTimezone()java.lang.String getUniqueID()
If the meaning of the 'Unique ID' attribute isn't clear, there really should be more of a description here...
setUniqueID(String),
ConfigurationPackage.getContextInstanceType_UniqueID()void setUniqueID(java.lang.String value)
Unique ID' attribute.
value - the new value of the 'Unique ID' attribute.getUniqueID()java.math.BigInteger getYear()
setYear(BigInteger),
ConfigurationPackage.getContextInstanceType_Year()void setYear(java.math.BigInteger value)
Year' attribute.
value - the new value of the 'Year' attribute.getYear()
|
TPTP 4.6.0 Platform Project Internal API Specification |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||