com.bowstreet.generation
Interface ProfileData

public interface ProfileData

The ProfileData interface provides access to the current profile being applied to the model.

Method Summary

java.lang.String	getExplicitProfiles() Gets the Explicit Profiles String that was used to build the ProfileData
java.lang.String	getMappedEntryName(java.lang.String profileSetEntryName) Gets the mapped ProfileSet:EntryName for the original specified ProfileSet:EntryName.
java.lang.String	getName() This will get the name of this ProfileData set.
Profile	getProfile(java.lang.String profileSetName) Gets the Profile object for a specified ProfileSet name.
java.lang.String	getString(java.lang.String entryName) Get a profile value.
java.lang.String	getUniqueKey() Get a unique key that can be used inside filenames, for instance
IXml	getXml(java.lang.String entryName) Get a complete XML value

Method Detail

getExplicitProfiles

java.lang.String getExplicitProfiles()

Gets the Explicit Profiles String that was used to build the ProfileData

Returns:

The Explicit Profiles String.

getMappedEntryName

java.lang.String getMappedEntryName(java.lang.String profileSetEntryName)

Gets the mapped ProfileSet:EntryName for the original specified ProfileSet:EntryName. If there is no mapping then the original ProfileSet:EntryName is returned. Note - This is only needed at regen time, since by runtime the names have already been mapped.

Parameters:

profileSetEntryName - The original name to get the mapped value for (e.g. Region:State).

Returns:

The mapped ProfileSet:EntryName (e.g. Region:State) or the original name if there was no mapping..

Example:

String newName = profileMapper.getMappedEntryName("Region:State");
 Where newName could be something like: "Portal:State_1"

getName

java.lang.String getName()

This will get the name of this ProfileData set. It is usable as a hashkey.

getProfile

Profile getProfile(java.lang.String profileSetName)

Gets the Profile object for a specified ProfileSet name.

Parameters:

profileSetName - The name of the ProfileSet to get the Profile for.

Returns:

The Profile, or null if not found.

getString

java.lang.String getString(java.lang.String entryName)

Get a profile value.

Parameters:

entryName - ProfileSetName:ProfileEntryName

getUniqueKey

java.lang.String getUniqueKey()

Get a unique key that can be used inside filenames, for instance

getXml

IXml getXml(java.lang.String entryName)

Get a complete XML value