org.hd.d.pg2k.webSvr.ads
Class AdBeanInterface.Context

java.lang.Object
  org.hd.d.pg2k.webSvr.ads.AdBeanInterface.Context

Enclosing interface:

AdBeanInterface

public static final class AdBeanInterface.Context
extends java.lang.Object

Details context in which advertisement is to be shown. Is immutable for thread-safety, etc.

Context items may be null, indicating that they are not applicable to this particular context, but any items that are non-null must be mutually consistent.

A generation routine is generally free to ignore all of the supplied data if it wishes to.

locale

private final java.util.Locale locale

The Locale of the visitor, or null. Assumed immutable, so handed out directly without a copy being taken (nor a copy made on construction).

gallerySection

private final java.lang.String gallerySection

The gallery section (top-level directory, or null. If not null and exhibit is non-null, must be the directory in exhibit.

exhibit

private final java.lang.String exhibit

The immutable details of the exhibit close to this ad, or null.

AdBeanInterface.Context

public AdBeanInterface.Context(java.util.Locale loc,
                               java.lang.String section,
                               java.lang.String exhibitName)

Construct a complete context. Items that do not apply can be null. Any that are non-null must be consistent with one another

Parameters:

loc - if non-null, the preferred locale

section - if non-null, the appropriate top-level Gallery section

exhibitName - if non-null, is the full name of the specific exhibit associated with this page

getLocale

public java.util.Locale getLocale()

Get the locale of the visitor, or null if none specified or relevant.

getGallerySection

public java.lang.String getGallerySection()

Get the gallery section (top-level directory) for this ad, or null if none relevant. If non-null and the exhibit is non-null, these two will be consistent.

getExhibit

public java.lang.String getExhibit()

Get the full name of the exhibit connected with this ad, or null if none relevant. If non-null and the exhibit is non-null, these two will be consistent.