Aztec® Programming Language
Version 1.1 Alpha 2

Copyright © 2010-2017, Aztec Development Group, All Rights Reserved

Download Aztec

Search        Contact Us

Sometimes you feel like you can fly away...

Sometimes you get lost.

- Dickey Betts

 

aztec.system.Metadata

public class Metadata from<Base>

Base

Metadata

The Metadata class is an abstract class which provides a framework for information related to the currently running script/application. Classes such as 'Class', 'Module', 'Method' and 'Data' provide a hierarchical view of all the classes, methods and data in the system.

 

'The Script class provides methods to get arrays of applicable metadata objects at the top level, including Script.GetUnits(), Script.GetModules() and Script.GetClasses(). Each of these classes in turn provides methods to get arrays of metadata objects that can exist within them, For instance, Module contains methods to get arrays of the classes and methods contained within the module, and Class contains a method to get an array of methods within the class.

 

This base class provides many methods to query whether various Aztec keywords were used with the definition of the metadata object.

 

Metadata Methods

Metadata() Constructor for the Metadata class
IsValid() Abstract method to be overridden by derived classes
Name() Returns the name of the metadata item
Space() Returns the space in which the metadata item is defined
IsFore() Returns true if 'fore' was used with this metadata object
IsBack() Returns true if 'back' was used with this metadata object
IsRef() Returns true if 'ref' was used with this metadata object
IsSync() Returns true if 'sync' was used with this metadata object
IsUnique() Returns true if 'unique' was used with this metadata object
IsShared() Returns true if 'shared' was used with this metadata object
IsFinal() Returns true if 'final' was used with this metadata object
IsVirtual() Returns true if 'virtual' was used with this metadata object
IsAbstract() Returns true if 'abstract' was used with this metadata object
IsPublic() Returns true if 'public' was used with this metadata object
IsPrivate() Returns true if 'private' was used with this metadata object
IsModule() Returns true if 'module' was used with this metadata object
IsFamily() Returns true if 'family' was used with this metadata object
IsSpace() Returns true if 'space' was used with this metadata object
IsUnit() Returns true if 'unit' was used with this metadata object

Derived Classes

See Also

 


Metadata()

public method Metadata(string Name, string Space)

Parameters

Name

Name of the metadata item

Space

Space in which the metadata item is created

Return Value

None

Description

Constructor for the abstract Metadata class.

 

Metadata Class


IsValid()

public abstract method<bool> IsValid()

Parameters

None

Return Value

True if metadata item is valid

Description

Abstract method to return true if the specified metadata item and space are valid and false if not. This method needs to be overridden by each derived class and handled appropriately.

 

Metadata Class


Name()

public method<string> Name()

Parameters

None

Return Value

Name of metadata item

Description

This method returns the name of the item for this metadata object.

 

Metadata Class


Space()

public method<string> Space()

Parameters

None

Return Value

Space metadata item is defined in

Description

This method returns the Aztec space in which the metadata item is defined.

 

Metadata Class


IsFore()

public method<bool> IsFore()

Parameters

None

Return Value

True if 'fore' was used

Description

Method returns true if the 'fore' keyword was specified during the definition of this metadata object.

 

Metadata Class


IsBack()

public method<bool> IsBack()

Parameters

None

Return Value

True if 'back' was used

Description

Method returns true if the 'back' keyword was specified during the definition of this metadata object.

 

Metadata Class


IsRef()

public method<bool> IsRef()

Parameters

None

Return Value

True if 'ref' was used

Description

Method returns true if the 'ref' keyword was specified during the definition of this metadata object.

 

Metadata Class


IsSync()

public method<bool> IsSync()

Parameters

None

Return Value

True if 'sync' was used

Description

Method returns true if the 'sync' keyword was specified during the definition of this metadata object.

 

Metadata Class


IsUnique()

public method<bool> IsUnique()

Parameters

None

Return Value

True if 'unique' was used

Description

Method returns true if the 'unique' keyword was specified during the definition of this metadata object.

 

Metadata Class


IsShared()

public method<bool> IsShared()

Parameters

None

Return Value

True if 'shared' was used

Description

Method returns true if the 'shared' keyword was specified during the definition of this metadata object.

 

Metadata Class


IsFinal()

public method<bool> IsFinal()

Parameters

None

Return Value

True if 'final' was used

Description

Method returns true if the 'final' keyword was specified during the definition of this metadata object.

 

Metadata Class


IsVirtual()

public method<bool> IsVirtual()

Parameters

None

Return Value

True if 'virtual' was used

Description

Method returns true if the 'virtual' keyword was specified during the definition of this metadata object.

 

Metadata Class


IsAbstract()

public method<bool> IsAbstract()

Parameters

None

Return Value

True if 'abstract' was used

Description

Method returns true if the 'abstract' keyword was specified during the definition of this metadata object.

 

Metadata Class


IsPublic()

public method<bool> IsPublic()

Parameters

None

Return Value

True if 'public' was used

Description

Method returns true if the 'public' keyword was specified during the definition of this metadata object.

 

Metadata Class


IsPrivate()

public method<bool> IsPrivate()

Parameters

None

Return Value

True if 'private' was used

Description

Method returns true if the 'private' keyword was specified during the definition of this metadata object.

 

Metadata Class


IsModule()

public method<bool> IsModule()

Parameters

None

Return Value

True if 'module' was used

Description

Method returns true if the 'module' keyword was specified during the definition of this metadata object.

 

Metadata Class


IsFamily()

public method<bool> IsFamily()

Parameters

None

Return Value

True if 'family' was used

Description

Method returns true if the 'family' keyword was specified during the definition of this metadata object.

 

Metadata Class


IsSpace()

public method<bool> IsSpace()

Parameters

None

Return Value

True if 'space' was used

Description

Method returns true if the 'space' keyword was specified during the definition of this metadata object.

 

Metadata Class


IsUnit()

public method<bool> IsUnit()

Parameters

None

Return Value

True if 'unit' was used

Description

Method returns true if the 'unit' keyword was specified during the definition of this metadata object.

 

Metadata Class

 

Copyright © 2010-2017

Aztec Development Group

All Rights Reserved

Download Aztec