wcs.java

Class Env

java.lang.Object

wcs.core.ICSProxyJ

wcs.java.Env

All Implemented Interfaces:

Content, Env

Direct Known Subclasses:

TestEnv

public class Env
extends wcs.core.ICSProxyJ
implements Content, Env

Facade to the Sites services. It is passed as the main argument to element logic.

Constructor Summary

Constructors

Constructor and Description
Env() Build the env - with this costructor you have an invalid env that still needs to be initialized with init to be usable
Env(ICS ics) Build the env from the ICS and initialize it

Method Summary

Methods

Modifier and Type	Method and Description
void	addDependency() Add a dependency on anything
void	addDependency(Id id) Add an EXACT dependency on a given asset
void	addDependency(Id id, AssetDeps deps) Add a dependency of the specified type on a given asset
void	addDependency(java.lang.String c) Add a dependency on any asset of the given type
void	addDependency(java.lang.String c, java.lang.Long cid) Add an EXACT dependency on a given asset
void	addDependency(java.lang.String c, java.lang.Long cid, AssetDeps deps) Add a dependency of the specified type on a given asset
java.lang.String	call(java.lang.String name, Arg... args) Call a CS Element in current site
void	clearError() Clear the current error code
java.lang.String	dump() Dump all the variables (NOT the lists...)
java.lang.String	dump(java.lang.String name) Dump the list with the given name
boolean	exists(java.lang.String attribute) Check if the give attribute is a valid value
boolean	exists(java.lang.String attribute, int pos) Check if the given attribute at the given position is a valid value
java.util.List<Id>	find(java.lang.String type, Arg... args) Find assets
Asset	findOne(java.lang.String type, Arg... args) Find one assets
Asset	getAsset() Return the asset identified by the current c/cid
Asset	getAsset(Id id) Return the asset identified by and Id (or null if not found)
Asset	getAsset(java.lang.String c, java.lang.Long cid) Return the asset identified by c/cid (or null if not possible)
java.lang.String	getC() Return current "c" (content type)
java.lang.Long	getCid() Return current "cid" (content id)
Config	getConfig() Return the current config
java.util.Date	getDate(java.lang.String var) Return the first attribute of the the attribute list as an int, or null if not found
java.util.Date	getDate(java.lang.String ls, int pos) Return the nth attribute of the the attribute list as an int, or null if not found
java.util.Date	getDate(java.lang.String ls, int pos, java.lang.String field) Get field at given position as a date, or null
java.util.Date	getDate(java.lang.String ls, java.lang.String field) Get field as date or null
int	getError() Get Error nummber
Id	getId() Return current asset id
java.lang.Integer	getInt(java.lang.String var) Return the first attribute of the the attribute list as an int, or null if not found
java.lang.Integer	getInt(java.lang.String ls, int pos) Return the nth attribute of the the attribute list as an int, or null if not found
java.lang.Integer	getInt(java.lang.String ls, int pos, java.lang.String field) Get field at given position as an int, or null
java.lang.Integer	getInt(java.lang.String ls, java.lang.String field) Get field as long or null
java.lang.Long	getLong(java.lang.String var) Get variable as Long or null
java.lang.Long	getLong(java.lang.String ls, int pos) Get the nth variable as Long or null
java.lang.Long	getLong(java.lang.String ls, int pos, java.lang.String field) Get field at given position as a long, or null
java.lang.Long	getLong(java.lang.String ls, java.lang.String field) Get field as long or null
java.lang.Object	getObject(java.lang.String object) Get an object
java.lang.Iterable<java.lang.Integer>	getRange(java.lang.String list) Return an iterable of the indexes of the attribute
Router	getRouter() Return the current router
java.lang.String	getSiteId() The current site id
java.lang.String	getSiteName() The current site name
SitePlan	getSitePlan()
int	getSize(java.lang.String list) Return the number of elements in the attribute
java.lang.String	getString(java.lang.String var) Return the first attribute of the the named attribute as a string, or null if not found
java.lang.String	getString(java.lang.String list, int row) Return the nth named attribute as a string, or null if not found
java.lang.String	getString(java.lang.String list, int row, java.lang.String field) Get the nth field of a list or null
java.lang.String	getString(java.lang.String list, java.lang.String field) Get the field of a list or null
java.lang.String	getUrl(Id id, Arg... args) Return the URL to render this asset - note that rendering is different if we are in insite/preview mode or in live mode
java.lang.String	getUrl(java.lang.String c, java.lang.Long cid, Arg... args) Return the URL to render this asset
ICS	ics() Return the underlying ICS
void	init(ICS ics) Initialize the env - second step constructor
boolean	isError() Check if in error state
boolean	isInsite() Check if we are in the insite editing mode
boolean	isList(java.lang.String list) Check if it is a list
boolean	isList(java.lang.String list, int n) Check if it is a list with enough rows
boolean	isListCol(java.lang.String list, java.lang.String field) Check if exists as a list column
boolean	isObj(java.lang.String object) Check if exists as an object
boolean	isVar(java.lang.String variable) Check if is a variable
void	unpackVar(java.lang.String var, java.lang.String packed) unpacks a var and puts it in ICS.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface wcs.api.Env

getSitePlanRoot

Constructor Detail

Env

public Env()

Build the env - with this costructor you have an invalid env that still needs to be initialized with init to be usable

Env

public Env(ICS ics)

Build the env from the ICS and initialize it

Parameters:

ics -

Method Detail

init

public void init(ICS ics)

Initialize the env - second step constructor

Specified by:

init in interface Env

Parameters:

ics -

getString

public java.lang.String getString(java.lang.String var)

Description copied from interface: Content

Return the first attribute of the the named attribute as a string, or null if not found

Specified by:

getString in interface Content

Specified by:

getString in interface Env

Returns:

getString

public java.lang.String getString(java.lang.String list,
                         java.lang.String field)

Description copied from interface: Env

Get the field of a list or null

Specified by:

getString in interface Env

Returns:

getString

public java.lang.String getString(java.lang.String list,
                         int row,
                         java.lang.String field)

Description copied from interface: Env

Get the nth field of a list or null

Specified by:

getString in interface Env

Returns:

getString

public java.lang.String getString(java.lang.String list,
                         int row)

Description copied from interface: Content

Return the nth named attribute as a string, or null if not found

Specified by:

getString in interface Content

Specified by:

getString in interface Env

Returns:

getSize

public int getSize(java.lang.String list)

Description copied from interface: Content

Return the number of elements in the attribute

Specified by:

getSize in interface Content

Specified by:

getSize in interface Env

Returns:

getRange

public java.lang.Iterable<java.lang.Integer> getRange(java.lang.String list)

Description copied from interface: Content

Return an iterable of the indexes of the attribute

Specified by:

getRange in interface Content

Specified by:

getRange in interface Env

Returns:

getDate

public java.util.Date getDate(java.lang.String var)

Description copied from interface: Content

Return the first attribute of the the attribute list as an int, or null if not found

Specified by:

getDate in interface Content

Specified by:

getDate in interface Env

Returns:

getInt

public java.lang.Integer getInt(java.lang.String var)

Description copied from interface: Content

Return the first attribute of the the attribute list as an int, or null if not found

Specified by:

getInt in interface Content

Specified by:

getInt in interface Env

Returns:

getLong

public java.lang.Long getLong(java.lang.String var)

Description copied from interface: Content

Get variable as Long or null

Specified by:

getLong in interface Content

Specified by:

getLong in interface Env

Returns:

getDate

public java.util.Date getDate(java.lang.String ls,
                     java.lang.String field)

Description copied from interface: Env

Get field as date or null

Specified by:

getDate in interface Env

Returns:

getInt

public java.lang.Integer getInt(java.lang.String ls,
                       java.lang.String field)

Description copied from interface: Env

Get field as long or null

Specified by:

getInt in interface Env

Returns:

getLong

public java.lang.Long getLong(java.lang.String ls,
                     java.lang.String field)

Description copied from interface: Env

Get field as long or null

Specified by:

getLong in interface Env

Returns:

getDate

public java.util.Date getDate(java.lang.String ls,
                     int pos,
                     java.lang.String field)

Description copied from interface: Env

Get field at given position as a date, or null

Specified by:

getDate in interface Env

Returns:

getDate

public java.util.Date getDate(java.lang.String ls,
                     int pos)

Description copied from interface: Content

Return the nth attribute of the the attribute list as an int, or null if not found

Specified by:

getDate in interface Content

Specified by:

getDate in interface Env

Returns:

getLong

public java.lang.Long getLong(java.lang.String ls,
                     int pos,
                     java.lang.String field)

Description copied from interface: Env

Get field at given position as a long, or null

Specified by:

getLong in interface Env

Returns:

getLong

public java.lang.Long getLong(java.lang.String ls,
                     int pos)

Description copied from interface: Content

Get the nth variable as Long or null

Specified by:

getLong in interface Content

Specified by:

getLong in interface Env

Returns:

getInt

public java.lang.Integer getInt(java.lang.String ls,
                       int pos,
                       java.lang.String field)

Description copied from interface: Env

Get field at given position as an int, or null

Specified by:

getInt in interface Env

Returns:

getInt

public java.lang.Integer getInt(java.lang.String ls,
                       int pos)

Description copied from interface: Content

Return the nth attribute of the the attribute list as an int, or null if not found

Specified by:

getInt in interface Content

Specified by:

getInt in interface Env

Returns:

getError

public int getError()

Description copied from interface: Env

Get Error nummber

Specified by:

getError in interface Env

isError

public boolean isError()

Description copied from interface: Env

Check if in error state

Specified by:

isError in interface Env

isVar

public boolean isVar(java.lang.String variable)

Description copied from interface: Env

Check if is a variable

Specified by:

isVar in interface Env

isList

public boolean isList(java.lang.String list)

Description copied from interface: Env

Check if it is a list

Specified by:

isList in interface Env

isList

public boolean isList(java.lang.String list,
             int n)

Description copied from interface: Env

Check if it is a list with enough rows

Specified by:

isList in interface Env

isListCol

public boolean isListCol(java.lang.String list,
                java.lang.String field)

Description copied from interface: Env

Check if exists as a list column

Specified by:

isListCol in interface Env

isObj

public boolean isObj(java.lang.String object)

Description copied from interface: Env

Check if exists as an object

Specified by:

isObj in interface Env

isInsite

public boolean isInsite()

Description copied from interface: Env

Check if we are in the insite editing mode

Specified by:

isInsite in interface Env

getObject

public java.lang.Object getObject(java.lang.String object)

Description copied from interface: Env

Get an object

Specified by:

getObject in interface Env

getAsset

public Asset getAsset(java.lang.String c,
             java.lang.Long cid)

Return the asset identified by c/cid (or null if not possible)

Specified by:

getAsset in interface Env

getAsset

public Asset getAsset(Id id)

Return the asset identified by and Id (or null if not found)

Specified by:

getAsset in interface Env

getAsset

public Asset getAsset()

Return the asset identified by the current c/cid

Specified by:

getAsset in interface Env

getC

public java.lang.String getC()

Description copied from interface: Env

Return current "c" (content type)

Specified by:

getC in interface Env

Returns:

getCid

public java.lang.Long getCid()

Description copied from interface: Env

Return current "cid" (content id)

Specified by:

getCid in interface Env

getId

public Id getId()

Description copied from interface: Env

Return current asset id

Specified by:

getId in interface Env

getConfig

public Config getConfig()

Description copied from interface: Env

Return the current config

Specified by:

getConfig in interface Env

getRouter

public Router getRouter()

Description copied from interface: Env

Return the current router

Specified by:

getRouter in interface Env

getSiteName

public java.lang.String getSiteName()

Description copied from interface: Env

The current site name

Specified by:

getSiteName in interface Env

getSiteId

public java.lang.String getSiteId()

Description copied from interface: Env

The current site id

Specified by:

getSiteId in interface Env

getSitePlan

public SitePlan getSitePlan()

Specified by:

getSitePlan in interface Env

getUrl

public java.lang.String getUrl(Id id,
                      Arg... args)

Description copied from interface: Env

Return the URL to render this asset - note that rendering is different if we are in insite/preview mode or in live mode

Specified by:

getUrl in interface Env

getUrl

public java.lang.String getUrl(java.lang.String c,
                      java.lang.Long cid,
                      Arg... args)

Description copied from interface: Env

Return the URL to render this asset

Specified by:

getUrl in interface Env

find

public java.util.List<Id> find(java.lang.String type,
                      Arg... args)

Description copied from interface: Env

Find assets

Specified by:

find in interface Env

findOne

public Asset findOne(java.lang.String type,
            Arg... args)

Find one assets

Specified by:

findOne in interface Env

call

public java.lang.String call(java.lang.String name,
                    Arg... args)

Description copied from interface: Env

Call a CS Element in current site

Specified by:

call in interface Env

Returns:

clearError

public void clearError()

Description copied from interface: Env

Clear the current error code

Specified by:

clearError in interface Env

addDependency

public void addDependency()

Description copied from interface: Env

Add a dependency on anything

Specified by:

addDependency in interface Env

addDependency

public void addDependency(java.lang.String c)

Description copied from interface: Env

Add a dependency on any asset of the given type

Specified by:

addDependency in interface Env

addDependency

public void addDependency(java.lang.String c,
                 java.lang.Long cid)

Description copied from interface: Env

Add an EXACT dependency on a given asset

Specified by:

addDependency in interface Env

addDependency

public void addDependency(java.lang.String c,
                 java.lang.Long cid,
                 AssetDeps deps)

Description copied from interface: Env

Add a dependency of the specified type on a given asset

Specified by:

addDependency in interface Env

addDependency

public void addDependency(Id id)

Description copied from interface: Env

Add an EXACT dependency on a given asset

Specified by:

addDependency in interface Env

addDependency

public void addDependency(Id id,
                 AssetDeps deps)

Description copied from interface: Env

Add a dependency of the specified type on a given asset

Specified by:

addDependency in interface Env

exists

public boolean exists(java.lang.String attribute)

Description copied from interface: Content

Check if the give attribute is a valid value

Specified by:

exists in interface Content

Specified by:

exists in interface Env

Returns:

exists

public boolean exists(java.lang.String attribute,
             int pos)

Description copied from interface: Content

Check if the given attribute at the given position is a valid value

Specified by:

exists in interface Content

Specified by:

exists in interface Env

Returns:

ics

public ICS ics()

Description copied from interface: Env

Return the underlying ICS

Specified by:

ics in interface Env

dump

public java.lang.String dump()

Dump all the variables (NOT the lists...)

Specified by:

dump in interface Content

Returns:

dump

public java.lang.String dump(java.lang.String name)

Dump the list with the given name

Specified by:

dump in interface Content

Returns:

unpackVar

public void unpackVar(java.lang.String var,
             java.lang.String packed)

unpacks a var and puts it in ICS. temporary workaround for the render:unpagkargs tag wrapper that's not working

Parameters:

var -

packed -