Document Class Reference

Inheritance diagram for Document:

Public Member Functions
_.Library.Status	OnConfigureMappings (pParams)
	Subclasses may override to customize mapping behavior at the beginning of the Reload phase.
	OnGetUniqueName (pUniqueName)
	Returns a unique name for this resource. More...
_.Library.String	OnItemRelativePath (_.Library.String pItemName)
	Returns the path relative to the module root for item pItemName within this resource.
_.Library.Status	OnLoad (_.Library.String pFullResourcePath, _.Library.Boolean pVerbose, _.Library.Boolean pCompile, _.Library.String pLoadedList, _.Library.String pParams)
	Subclasses may override to customize resource load behavior during the Reload phase. More...
_.Library.Status	OnPhase (_.Library.String pPhase, pParams, _.Library.Boolean pResourceHandled)
	Called as phase pPhase is executed for the resource. More...
_.Library.Status	OnResolveChildren (pResourceArray)
	Enumerate all documents contained in the resource being processed. More...
Public Member Functions inherited from Abstract
	OnGetStudioProject (_.Studio.Project pProject, _.Library.Boolean pHandled)
	Subclasses may override to customize the studio project. More...

Static Public Member Functions
_.Library.Boolean	ResourceIsMappedToDefaultDB (_.Library.String pResourceName)
	Helper method to be used in derived classes' OnConfigureMappings() to skip creating unnecessary mappings. More...

Public Attributes
	Compile
	If true, the resource will be compiled during the compilation phase in the module lifecycle. More...
	Directory
	Directory relative to module root containing the exported resource. More...
	DirectoryDefined
	More...
	FilenameExtension
	Extension for individual filename(s) that comprise this resource. More...
	FilenameTranslateAssociator
	Characters in the filename to use as the associator in $translate when determining the resource's filename on disk. More...
	FilenameTranslateIdentifier
	Characters in the filename to use as the identifier in $translate when determining the resource's filename on disk. More...
	Format
	Export format - list of acceptable values may differ by subclass. More...
	LoadAsDirectory
	If true (default is false), the resource is loaded as a directory. More...
Public Attributes inherited from AbstractCompilable
	CompileAfter
	Comma-separated list of resource names after which this resource should be compiled. More...
	ExportFlags
	Flags/qualifiers to export items with. More...
	Flags
	Flags/qualifiers to compile with (overriding any more general defaults); "verbose" added per lifecycle command. More...
Public Attributes inherited from Abstract
	Params
	More...

Static Public Attributes
	ATTRIBUTES = None
	Comma-separated list of resource attribute names that this processor uses.
	DESCRIPTION = None
	Description of resource processor class (shown in UI)
	EXTENSION = None
	May be set to determine the value of <property>Extension</property> based on a static value rather than based on the resource name. More...
	NAMEPOSTFIX = None
	When a module is loaded in developer mode, this is appended to the resource name in ^Sources - e.g., ^Sources(..Extension, <resource name>_..NAMEPOSTFIX) More...
Static Public Attributes inherited from AbstractCompilable
	ATTRIBUTES = None
	Comma-separated list of resource attribute names that this processor uses.
	DESCRIPTION = None
	Description of resource processor class (shown in UI)
Static Public Attributes inherited from Abstract
	ATTRIBUTES = None
	Comma-separated list of resource attribute names that this processor uses.
	DESCRIPTION = None
	Description of resource processor class (shown in UI)

Private Attributes
	__Extension
	Extension of the server document(s) represented by this resource. More...
	__Name
	Name of the server document (without extension) More...

Member Function Documentation

OnGetUniqueName()

OnGetUniqueName

(

pUniqueName

)

Returns a unique name for this resource.

Default implementation, leaving pUniqueName undefined, reverts to default behavior. An empty string indicates guaranteed uniqueness (useful for folders relative to module root)

Reimplemented from Abstract.

Reimplemented in DeepSeeItem.

OnLoad()

_.Library.Status OnLoad	(	_.Library.String	pFullResourcePath,
		_.Library.Boolean	pVerbose,
		_.Library.Boolean	pCompile,
		_.Library.String	pLoadedList,
		_.Library.String	pParams
	)

Subclasses may override to customize resource load behavior during the Reload phase.

@Argument pFullResourcePath The absolute path to the resource present on the file system @Argument pVerbose 1: display output from loading files, 0: do not display output @Argument pCompile 1: compile files upon load, 0: do not compile files @Argument pLoadedList Output: comma delimited list of files that have been loaded

OnPhase()

_.Library.Status OnPhase	(	_.Library.String	pPhase,
			pParams,
		_.Library.Boolean	pResourceHandled
	)

Called as phase pPhase is executed for the resource.

If pResourceHandled is set to true,

then the default behavior for that resource will be bypassed in the current phase. Currently, this is only used in the Verify phase, because of different handling of intermediate error statuses. TODO: Implement for standard database resources (.INC, .CLS, etc.)

Reimplemented from Abstract.

Reimplemented in LocalizedMessages, and DeepSeeItem.

OnResolveChildren()

_.Library.Status OnResolveChildren

(

pResourceArray

)

Enumerate all documents contained in the resource being processed.

@Argument pResourceArray ByRef: array of the following format: pResourceArray(<Studio document name>) = <module that contains document> pResourceArray(<Studio document name>, <resource referenty property>) = value of resource reference property for given document

Reimplemented in Package, and DeepSeeItem.

ResourceIsMappedToDefaultDB()

_.Library.Boolean ResourceIsMappedToDefaultDB ( _.Library.String  pResourceName )

static

Helper method to be used in derived classes' OnConfigureMappings() to skip creating unnecessary mappings.

Returns true if pResourceName (in InternalName format - e.g., Foo.Bar.PKG) is mapped to the current namespace's default routine database.

Member Data Documentation

EXTENSION

EXTENSION = None

static

May be set to determine the value of <property>Extension</property> based on a static value rather than based on the resource name.

The only expected use case at this point is class packages (.PKG, but Extension will be .CLS)

NAMEPOSTFIX

NAMEPOSTFIX = None

static

When a module is loaded in developer mode, this is appended to the resource name in ^Sources - e.g., ^Sources(..Extension, <resource name>_..NAMEPOSTFIX)

The only expected use case at this point is class packages (.PKG, but Extension will be .CLS)

Compile

Compile

If true, the resource will be compiled during the compilation phase in the module lifecycle.

 

Directory

Directory

Directory relative to module root containing the exported resource.

Defaults to the resource's extension (lower-case) if unspecified.  

DirectoryDefined

DirectoryDefined

 

 

__Extension

__Extension

private

Extension of the server document(s) represented by this resource.

 

FilenameExtension

FilenameExtension

Extension for individual filename(s) that comprise this resource.

 

FilenameTranslateAssociator

FilenameTranslateAssociator

Characters in the filename to use as the associator in $translate when determining the resource's filename on disk.

The default behavior is to replace "." with "/" and ignore "%"  

FilenameTranslateIdentifier

FilenameTranslateIdentifier

Characters in the filename to use as the identifier in $translate when determining the resource's filename on disk.

The default behavior is to replace "." with "/" and ignore "%"  

Format

Format

Export format - list of acceptable values may differ by subclass.

 

LoadAsDirectory

LoadAsDirectory

If true (default is false), the resource is loaded as a directory.

 

__Name

__Name

private

Name of the server document (without extension)