org.eclipse.hyades.logging.adapter.model.internal.extractor
Interface ExtractorType

All Superinterfaces:

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

All Known Implementing Classes:

ExtractorTypeImpl

public interface ExtractorType
extends ProcessUnitType

A representation of the model object 'Type'. An extractor has the role of given the input array of for example strings to create a structure that hold exactly one complete message. An extractor actually returns an array of these structured objects.

The following features are supported:

• Contains Line Breaks
• End Pattern
• Include End Pattern
• Include Start Pattern
• Line Break Symbol
• Replace Line Breaks
• Start Pattern

See Also:

ExtractorPackage.getExtractorType()

Generated

[EMF] Model

extendedMetaData="name='ExtractorType' kind='elementOnly'"

Method Summary

java.lang.String	getEndPattern() Returns the value of the 'End Pattern' attribute
java.lang.String	getLineBreakSymbol() Returns the value of the 'Line Break Symbol' attribute
java.lang.String	getStartPattern() Returns the value of the 'Start Pattern' attribute
boolean	isContainsLineBreaks() Returns the value of the 'Contains Line Breaks' attribute
boolean	isIncludeEndPattern() Returns the value of the 'Include End Pattern' attribute
boolean	isIncludeStartPattern() Returns the value of the 'Include Start Pattern' attribute
boolean	isReplaceLineBreaks() Returns the value of the 'Replace Line Breaks' attribute
boolean	isSetContainsLineBreaks() Returns whether the value of the 'Contains Line Breaks' attribute is set
boolean	isSetIncludeEndPattern() Returns whether the value of the 'Include End Pattern' attribute is set
boolean	isSetIncludeStartPattern() Returns whether the value of the 'Include Start Pattern' attribute is set
boolean	isSetReplaceLineBreaks() Returns whether the value of the 'Replace Line Breaks' attribute is set
void	setContainsLineBreaks(boolean value) Sets the value of the 'Contains Line Breaks' attribute
void	setEndPattern(java.lang.String value) Sets the value of the 'End Pattern' attribute
void	setIncludeEndPattern(boolean value) Sets the value of the 'Include End Pattern' attribute
void	setIncludeStartPattern(boolean value) Sets the value of the 'Include Start Pattern' attribute
void	setLineBreakSymbol(java.lang.String value) Sets the value of the 'Line Break Symbol' attribute
void	setReplaceLineBreaks(boolean value) Sets the value of the 'Replace Line Breaks' attribute
void	setStartPattern(java.lang.String value) Sets the value of the 'Start Pattern' attribute
void	unsetContainsLineBreaks() Unsets the value of the 'Contains Line Breaks' attribute
void	unsetIncludeEndPattern() Unsets the value of the 'Include End Pattern' attribute
void	unsetIncludeStartPattern() Unsets the value of the 'Include Start Pattern' attribute
void	unsetReplaceLineBreaks() Unsets the value of the 'Replace Line Breaks' attribute

Methods inherited from interface org.eclipse.hyades.logging.adapter.model.internal.unit.ProcessUnitType

getDescription, getProperty, getUniqueID, isDisabled, isSetDisabled, setDescription, setDisabled, setUniqueID, unsetDisabled

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

isContainsLineBreaks

boolean isContainsLineBreaks()

Returns the value of the 'Contains Line Breaks' attribute. If a message can contain or more precisely span multiple lines of an input file which would typically mean spans Objects in the input array then this attribute would be set to true.

Returns:

the value of the 'Contains Line Breaks' attribute.

See Also:

isSetContainsLineBreaks(), unsetContainsLineBreaks(), setContainsLineBreaks(boolean), ExtractorPackage.getExtractorType_ContainsLineBreaks()

Generated

[EMF] Model

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

setContainsLineBreaks

void setContainsLineBreaks(boolean value)

Sets the value of the 'Contains Line Breaks' attribute.

Parameters:

value - the new value of the 'Contains Line Breaks' attribute.

See Also:

isSetContainsLineBreaks(), unsetContainsLineBreaks(), isContainsLineBreaks()

Generated

unsetContainsLineBreaks

void unsetContainsLineBreaks()

Unsets the value of the 'Contains Line Breaks' attribute.

See Also:

isSetContainsLineBreaks(), isContainsLineBreaks(), setContainsLineBreaks(boolean)

Generated

isSetContainsLineBreaks

boolean isSetContainsLineBreaks()

Returns whether the value of the 'Contains Line Breaks' attribute is set.

Returns:

whether the value of the 'Contains Line Breaks' attribute is set.

See Also:

unsetContainsLineBreaks(), isContainsLineBreaks(), setContainsLineBreaks(boolean)

Generated

getEndPattern

java.lang.String getEndPattern()

Returns the value of the 'End Pattern' attribute. This string defines the expression used by the extractor to identify the end of a message.

Returns:

the value of the 'End Pattern' attribute.

See Also:

setEndPattern(String), ExtractorPackage.getExtractorType_EndPattern()

Generated

[EMF] Model

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

setEndPattern

void setEndPattern(java.lang.String value)

Sets the value of the 'End Pattern' attribute.

Parameters:

value - the new value of the 'End Pattern' attribute.

See Also:

getEndPattern()

Generated

isIncludeEndPattern

boolean isIncludeEndPattern()

Returns the value of the 'Include End Pattern' attribute. Define if the matched ending string should be included in the resulting message string.

Returns:

the value of the 'Include End Pattern' attribute.

See Also:

isSetIncludeEndPattern(), unsetIncludeEndPattern(), setIncludeEndPattern(boolean), ExtractorPackage.getExtractorType_IncludeEndPattern()

Generated

[EMF] Model

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

setIncludeEndPattern

void setIncludeEndPattern(boolean value)

Sets the value of the 'Include End Pattern' attribute.

Parameters:

value - the new value of the 'Include End Pattern' attribute.

See Also:

isSetIncludeEndPattern(), unsetIncludeEndPattern(), isIncludeEndPattern()

Generated

unsetIncludeEndPattern

void unsetIncludeEndPattern()

Unsets the value of the 'Include End Pattern' attribute.

See Also:

isSetIncludeEndPattern(), isIncludeEndPattern(), setIncludeEndPattern(boolean)

Generated

isSetIncludeEndPattern

boolean isSetIncludeEndPattern()

Returns whether the value of the 'Include End Pattern' attribute is set.

Returns:

whether the value of the 'Include End Pattern' attribute is set.

See Also:

unsetIncludeEndPattern(), isIncludeEndPattern(), setIncludeEndPattern(boolean)

Generated

isIncludeStartPattern

boolean isIncludeStartPattern()

Returns the value of the 'Include Start Pattern' attribute. Define if the matched starting string should be included in the resulting message string.

Returns:

the value of the 'Include Start Pattern' attribute.

See Also:

isSetIncludeStartPattern(), unsetIncludeStartPattern(), setIncludeStartPattern(boolean), ExtractorPackage.getExtractorType_IncludeStartPattern()

Generated

[EMF] Model

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

setIncludeStartPattern

void setIncludeStartPattern(boolean value)

Sets the value of the 'Include Start Pattern' attribute.

Parameters:

value - the new value of the 'Include Start Pattern' attribute.

See Also:

isSetIncludeStartPattern(), unsetIncludeStartPattern(), isIncludeStartPattern()

Generated

unsetIncludeStartPattern

void unsetIncludeStartPattern()

Unsets the value of the 'Include Start Pattern' attribute.

See Also:

isSetIncludeStartPattern(), isIncludeStartPattern(), setIncludeStartPattern(boolean)

Generated

isSetIncludeStartPattern

boolean isSetIncludeStartPattern()

Returns whether the value of the 'Include Start Pattern' attribute is set.

Returns:

whether the value of the 'Include Start Pattern' attribute is set.

See Also:

unsetIncludeStartPattern(), isIncludeStartPattern(), setIncludeStartPattern(boolean)

Generated

getLineBreakSymbol

java.lang.String getLineBreakSymbol()

Returns the value of the 'Line Break Symbol' attribute. If a message spans multiple lines of an input file, those lines are concatenated into one line. In cases where preserving the line boundary is needed, a substitution string can be defined by providing a value for this attribute.

Returns:

the value of the 'Line Break Symbol' attribute.

See Also:

setLineBreakSymbol(String), ExtractorPackage.getExtractorType_LineBreakSymbol()

Generated

[EMF] Model

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

setLineBreakSymbol

void setLineBreakSymbol(java.lang.String value)

Sets the value of the 'Line Break Symbol' attribute.

Parameters:

value - the new value of the 'Line Break Symbol' attribute.

See Also:

getLineBreakSymbol()

Generated

isReplaceLineBreaks

boolean isReplaceLineBreaks()

Returns the value of the 'Replace Line Breaks' attribute. If a message contains line breaks, sometimes it is desireable to leave them in and sometimes replace them with an alternate string. This can be achieved by setting this attribute to false or true respectively. In the case where they should simply be removed set this attribute to true and the replacement string to "".

Returns:

the value of the 'Replace Line Breaks' attribute.

See Also:

isSetReplaceLineBreaks(), unsetReplaceLineBreaks(), setReplaceLineBreaks(boolean), ExtractorPackage.getExtractorType_ReplaceLineBreaks()

Generated

[EMF] Model

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

setReplaceLineBreaks

void setReplaceLineBreaks(boolean value)

Sets the value of the 'Replace Line Breaks' attribute.

Parameters:

value - the new value of the 'Replace Line Breaks' attribute.

See Also:

isSetReplaceLineBreaks(), unsetReplaceLineBreaks(), isReplaceLineBreaks()

Generated

unsetReplaceLineBreaks

void unsetReplaceLineBreaks()

Unsets the value of the 'Replace Line Breaks' attribute.

See Also:

isSetReplaceLineBreaks(), isReplaceLineBreaks(), setReplaceLineBreaks(boolean)

Generated

isSetReplaceLineBreaks

boolean isSetReplaceLineBreaks()

Returns whether the value of the 'Replace Line Breaks' attribute is set.

Returns:

whether the value of the 'Replace Line Breaks' attribute is set.

See Also:

unsetReplaceLineBreaks(), isReplaceLineBreaks(), setReplaceLineBreaks(boolean)

Generated

getStartPattern

java.lang.String getStartPattern()

Returns the value of the 'Start Pattern' attribute. This string defines the expression used by the extractor to identify the beginning of a message.

Returns:

the value of the 'Start Pattern' attribute.

See Also:

setStartPattern(String), ExtractorPackage.getExtractorType_StartPattern()

Generated

[EMF] Model

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

setStartPattern

void setStartPattern(java.lang.String value)

Sets the value of the 'Start Pattern' attribute.

Parameters:

value - the new value of the 'Start Pattern' attribute.

See Also:

getStartPattern()

Generated