TdjPathMap Class Reference

Holds all known web component mappings for a context. More...

Inheritance diagram for TdjPathMap:

Public Member Functions
TSpecType	GetSpecType (const string Spec)
Boolean	Matches (const string Path, const string Spec)
	CheckExists (const string UrlPattern)
	Check if a mapping path exists.
	AddUrlPattern (const string UrlPattern, TObject Value)
	Add a web component mapping.
TStrings	GetMatches (const string Path)
	Return all matching mappings for the given path.

Protected Member Functions
Boolean	Matches (const string Path, const string Spec, TSpecType SpecType)

Detailed Description

Holds all known web component mappings for a context.

Matching is performed in the following order Exact match Longest prefix match Longest suffix match

Member Function Documentation

AddUrlPattern()

TdjPathMap::AddUrlPattern	(	const string	UrlPattern,
		TObject	Value )

Add a web component mapping.

Parameters

UrlPattern	a single component mapping path (for example, '.html' or '/')
Value	the mapped web component

Exceptions

EWebComponentException

References CheckExists().

CheckExists()

TdjPathMap::CheckExists

(

const string

UrlPattern

)

Check if a mapping path exists.

This procedure throws a EWebComponentException if the URL pattern is already registered for this context.

Parameters

UrlPattern

a single component mapping path (for example, '.html' or '/')

Exceptions

EWebComponentException

Referenced by AddUrlPattern().

GetMatches()

TStrings TdjPathMap::GetMatches

(

const string

Path

)

Return all matching mappings for the given path.

The best match will be the first entry.

Parameters

Path	the URL path (without context), for example 'test.html'

Returns

list of matching mappings

GetSpecType()

class TSpecType TdjPathMap::GetSpecType

(

const string

Spec

)

Parameters

Spec	the path specification (for example, '/*')

Returns

the path specification type

Matches()

class Boolean TdjPathMap::Matches ( const string Path, const string Spec, TSpecType SpecType )

protected

Parameters

Path	the URL document path
Spec	the path specification (for example, '/*')
SpecType	the path specification type

Returns

True if the Path mathes the Spec (with known SpecType)