C# Class Ecologylab.BigSemantics.Actions.SemanticOperation

missing java doc comments or could not find the source file.
Inheritance: Simpl.Serialization.ElementState
Datei anzeigen Open project: ecologylab/BigSemanticsCSharp Class Usage Examples

Public Properties

Property Type Description
FIN int
INIT int
INTER int

Protected Properties

Property Type Description
documentParser Ecologylab.BigSemantics.Documentparsers.DocumentParser
semanticOperationHandler SemanticOperationHandler
sessionScope Ecologylab.BigSemantics.Collecting.SemanticsGlobalScope

Public Methods

Method Description
GetArgumentAltValueName ( String argName ) : String
GetArgumentBoolean ( String argName, bool defaultValue ) : bool
GetArgumentFloat ( String argName, float defaultValue ) : float
GetArgumentInteger ( String argName, int defaultValue ) : int
GetArgumentObject ( String argName ) : Object
GetArgumentValueName ( String argName ) : String
GetMetaMetadata ( ElementState that ) : MetaMetadata
GetOperationName ( ) : String

return the name of the operation.

GetOrCreateDocument ( DocumentParser documentParser ) : Document
GetReturnObjectName ( ) : String
GetSemanticOperationHandler ( ) : SemanticOperationHandler
HandleError ( ) : void
HasArguments ( ) : bool
Perform ( Object obj ) : Object
Register ( Type semanticOperationClasses ) : void

Register a user defined semantic operation to the system. This method should be called before compiling or using the MetaMetadata repository.

To override an existing semantic operation, subclass your own semantic operation class, use the same tag (indicated in @simpl_tag), and override perform(). @param semanticOperationClass @param canBeNested indicates if this semantic operation can be nested by other semantic operations, like for or if. if so, it will also be registered to NestedSemanticOperationTranslationScope.

SemanticOperation ( ) : System
SetNestedOperationState ( String name, Object value ) : void

Protected Methods

Method Description
GetMetaMetadata ( ) : MetaMetadata
ResolveSourceDocument ( ) : Document

Method Details

GetArgumentAltValueName() public method

public GetArgumentAltValueName ( String argName ) : String
argName String
return String

GetArgumentBoolean() public method

public GetArgumentBoolean ( String argName, bool defaultValue ) : bool
argName String
defaultValue bool
return bool

GetArgumentFloat() public method

public GetArgumentFloat ( String argName, float defaultValue ) : float
argName String
defaultValue float
return float

GetArgumentInteger() public method

public GetArgumentInteger ( String argName, int defaultValue ) : int
argName String
defaultValue int
return int

GetArgumentObject() public method

public GetArgumentObject ( String argName ) : Object
argName String
return Object

GetArgumentValueName() public method

public GetArgumentValueName ( String argName ) : String
argName String
return String

GetMetaMetadata() protected method

protected GetMetaMetadata ( ) : MetaMetadata
return MetaMetadata

GetMetaMetadata() public static method

public static GetMetaMetadata ( ElementState that ) : MetaMetadata
that Simpl.Serialization.ElementState
return MetaMetadata

GetOperationName() public abstract method

return the name of the operation.
public abstract GetOperationName ( ) : String
return String

GetOrCreateDocument() public method

public GetOrCreateDocument ( DocumentParser documentParser ) : Document
documentParser Ecologylab.BigSemantics.Documentparsers.DocumentParser
return Ecologylab.BigSemantics.MetadataNS.Builtins.Document

GetReturnObjectName() public method

public GetReturnObjectName ( ) : String
return String

GetSemanticOperationHandler() public method

public GetSemanticOperationHandler ( ) : SemanticOperationHandler
return SemanticOperationHandler

HandleError() public abstract method

public abstract HandleError ( ) : void
return void

HasArguments() public method

public HasArguments ( ) : bool
return bool

Perform() public abstract method

public abstract Perform ( Object obj ) : Object
obj Object
return Object

Register() public static method

Register a user defined semantic operation to the system. This method should be called before compiling or using the MetaMetadata repository.

To override an existing semantic operation, subclass your own semantic operation class, use the same tag (indicated in @simpl_tag), and override perform(). @param semanticOperationClass @param canBeNested indicates if this semantic operation can be nested by other semantic operations, like for or if. if so, it will also be registered to NestedSemanticOperationTranslationScope.

public static Register ( Type semanticOperationClasses ) : void
semanticOperationClasses System.Type
return void

ResolveSourceDocument() protected method

protected ResolveSourceDocument ( ) : Document
return Ecologylab.BigSemantics.MetadataNS.Builtins.Document

SemanticOperation() public method

public SemanticOperation ( ) : System
return System

SetNestedOperationState() public method

public SetNestedOperationState ( String name, Object value ) : void
name String
value Object
return void

Property Details

FIN public_oe static_oe property

public static int FIN
return int

INIT public_oe static_oe property

public static int INIT
return int

INTER public_oe static_oe property

public static int INTER
return int

documentParser protected_oe property

protected DocumentParser,Ecologylab.BigSemantics.Documentparsers documentParser
return Ecologylab.BigSemantics.Documentparsers.DocumentParser

semanticOperationHandler protected_oe property

protected SemanticOperationHandler semanticOperationHandler
return SemanticOperationHandler

sessionScope protected_oe property

protected SemanticsGlobalScope,Ecologylab.BigSemantics.Collecting sessionScope
return Ecologylab.BigSemantics.Collecting.SemanticsGlobalScope