public class TurbineUtils extends Object
Modifier and Type | Field and Description |
---|---|
protected Map<String,List<Properties>> |
cachedVMS |
static String |
EDIT_ITEM |
Modifier and Type | Method and Description |
---|---|
static String |
createContentDispositionValue(String filename,
boolean isAttachment)
Creates the value to be set for a content disposition header.
|
String |
escapeHTML(String o) |
String |
escapeJS(String o) |
static Object |
escapeParam(Object o) |
static String |
escapeParam(String o) |
String |
formatDate(Date d) |
String |
formatDate(Date d,
String pattern) |
String |
formatDate(long d,
String pattern) |
String |
formatDateTime(Date d) |
String |
formatDateTimeSeconds(Date d) |
String |
formatNumber(Object o,
int roundTo) |
String |
formatTime(Date d) |
Object |
getArrayIndex(Object[] array,
int index) |
static String |
GetContext() |
static Map<String,String> |
GetContextParameterHash(org.apache.velocity.context.Context context) |
static ItemI |
getDataItem(org.apache.turbine.util.RunData data) |
static Map<String,String> |
GetDataParameterHash(org.apache.turbine.util.RunData data) |
static List<String> |
GetDataParameterList(org.apache.turbine.util.RunData data) |
static SimpleDateFormat |
getDateFormatter() |
static SimpleDateFormat |
getDateTimeFormatter() |
static SimpleDateFormat |
getDateTimeSecondsFormatter() |
static DisplaySearch |
getDSFromSearchXML(org.apache.turbine.util.RunData data) |
static ItemI |
GetEditItem(org.apache.turbine.util.RunData data) |
static String |
GetFullServerPath()
Returns server & context as specified in the Turbine object model (taken from the first login url).
|
static String |
GetFullServerPath(javax.servlet.http.HttpServletRequest req)
Returns server & context as specified in user request object.
|
static TurbineUtils |
GetInstance() |
static XFTItem |
GetItemBySearch(org.apache.turbine.util.RunData data) |
static ItemI |
GetItemBySearch(org.apache.turbine.util.RunData data,
boolean preLoad) |
static ItemI |
GetItemBySearch(org.apache.turbine.util.RunData data,
Boolean preload) |
static ItemI |
GetParticipantItem(org.apache.turbine.util.RunData data) |
static Boolean |
GetPassedBoolean(String s,
org.apache.turbine.util.RunData data) |
static Integer |
GetPassedInteger(String s,
org.apache.turbine.util.RunData data) |
static Integer |
GetPassedInteger(String s,
org.apache.turbine.util.RunData data,
Integer defualt) |
static Object[] |
GetPassedObjects(String s,
org.apache.turbine.util.RunData data) |
static Object |
GetPassedParameter(String s,
org.apache.turbine.util.RunData data) |
static Object |
GetPassedParameter(String s,
org.apache.turbine.util.RunData data,
Object defaultValue) |
static Collection<String> |
GetPassedStrings(String s,
org.apache.turbine.util.RunData data) |
Object |
getProject(Object objectModel,
String projectId) |
String |
getProjectDisplayID(Object objectModel,
Object project)
This should only happen when objectModel and project are both actually projects.
|
String |
getProjectDisplayID(Object objectModel,
String projectId)
Object type disambiguation helper.
|
String |
getProjectName(Object objectModel,
String projectId)
Object type disambiguation helper.
|
static String |
GetRelativePath(javax.servlet.http.HttpServletRequest req) |
static String |
GetRelativeServerPath(org.apache.turbine.util.RunData data)
Returns server & context as specified in user request object.
|
static SchemaElementI |
GetSchemaElementBySearch(org.apache.turbine.util.RunData data) |
static DisplaySearch |
getSearch(org.apache.turbine.util.RunData data) |
static String |
GetSearchElement(org.apache.turbine.util.RunData data) |
Integer |
getSecurityID() |
static String |
getStoredElementName(org.apache.turbine.util.RunData data) |
static Integer |
GetSystemID() |
static String |
GetSystemName() |
String |
getTemplateName(String module,
String dataType,
String project) |
String |
getTemplateName(String module,
String dataType,
String project,
String subFolder) |
List<Properties> |
getTemplates(String subFolder)
Note: much of this was copied from SecureScreen.
|
List<Properties> |
getTemplates(String dataType,
String subFolder)
Looks for templates in the give subFolder underneath the give dataType in the xdat-templates, xnat-templates, or templates.
|
static SimpleDateFormat |
getTimeFormatter() |
static Map<String,String> |
GetTurbineParameters(org.apache.turbine.util.RunData data,
org.apache.velocity.context.Context context) |
static XDATUser |
getUser(org.apache.turbine.util.RunData data) |
int |
getYear() |
static boolean |
HasPassedParameter(String s,
org.apache.turbine.util.RunData data) |
static void |
InstanciatePassedItemForScreenUse(org.apache.turbine.util.RunData data,
org.apache.velocity.context.Context context) |
boolean |
loginRequired() |
static boolean |
LoginRequired() |
static void |
OutputContextParameters(org.apache.velocity.context.Context context)
Debugging method used in actions to display all parameters in the Context object
|
static void |
OutputDataParameters(org.apache.turbine.util.RunData data) |
static void |
OutputGroupFields(org.apache.turbine.services.intake.model.Group group)
Debugging method used in actions to display all fields in an Intake Group.
|
static void |
OutputPassedParameters(org.apache.turbine.util.RunData data,
org.apache.velocity.context.Context context,
String name) |
static void |
OutputSessionParameters(org.apache.turbine.util.RunData data) |
static void |
setContentDisposition(javax.servlet.http.HttpServletResponse response,
String filename)
Sets the Content-Disposition response header.
|
static void |
setContentDisposition(javax.servlet.http.HttpServletResponse response,
String filename,
boolean isAttachment)
Sets the Content-Disposition response header.
|
static org.apache.turbine.util.RunData |
setDataItem(org.apache.turbine.util.RunData data,
ItemI item) |
static void |
SetEditItem(ItemI item,
org.apache.turbine.util.RunData data) |
static void |
setNewUser(org.apache.turbine.util.RunData data,
XDATUser user,
org.apache.velocity.context.Context context) |
static void |
SetParticipantItem(ItemI item,
org.apache.turbine.util.RunData data) |
static void |
setSearch(org.apache.turbine.util.RunData data,
DisplaySearch search)
Findbugs says DisplaySearch should be serializable.
|
static void |
SetSearchProperties(org.apache.velocity.context.Context context,
ItemI item) |
static org.apache.turbine.util.RunData |
SetSearchProperties(org.apache.turbine.util.RunData data,
ItemI item) |
static void |
setStoredElementName(org.apache.turbine.util.RunData data,
String elementName) |
static void |
setUser(org.apache.turbine.util.RunData data,
XDATUser user) |
boolean |
templateExists(String screen) |
Boolean |
toBoolean(String s) |
String[] |
toList(String s) |
static Object |
unescapeParam(Object o)
If a value is placed into a form field via JavaScript, it must be unescaped first,
otherwise the value will be XML-encoded, and it will be double-encoded on re-tranmission to the server.
|
static String |
unescapeParam(String o) |
String |
validateTemplate(String[] screens,
String project) |
String |
validateTemplate(String screen,
String project) |
public static final String EDIT_ITEM
protected final Map<String,List<Properties>> cachedVMS
public static TurbineUtils GetInstance()
public Integer getSecurityID()
public static Integer GetSystemID()
public static String GetSystemName()
public boolean loginRequired()
public static boolean LoginRequired()
public static ItemI GetItemBySearch(org.apache.turbine.util.RunData data, boolean preLoad) throws Exception
Exception
public static SchemaElementI GetSchemaElementBySearch(org.apache.turbine.util.RunData data)
public static XFTItem GetItemBySearch(org.apache.turbine.util.RunData data) throws IllegalAccessException, MetaDataException, Exception
public static ItemI GetItemBySearch(org.apache.turbine.util.RunData data, Boolean preload) throws IllegalAccessException, MetaDataException, Exception
public static void SetEditItem(ItemI item, org.apache.turbine.util.RunData data)
public static ItemI GetEditItem(org.apache.turbine.util.RunData data)
public static void SetParticipantItem(ItemI item, org.apache.turbine.util.RunData data)
public static ItemI GetParticipantItem(org.apache.turbine.util.RunData data)
public static String GetSearchElement(org.apache.turbine.util.RunData data)
public static String GetFullServerPath()
public static String GetRelativeServerPath(org.apache.turbine.util.RunData data)
data
- public static String GetRelativePath(javax.servlet.http.HttpServletRequest req)
public static String GetFullServerPath(javax.servlet.http.HttpServletRequest req)
req
- Servlet requestpublic static String GetContext()
public static XDATUser getUser(org.apache.turbine.util.RunData data)
public static void setUser(org.apache.turbine.util.RunData data, XDATUser user) throws Exception
Exception
public static void setNewUser(org.apache.turbine.util.RunData data, XDATUser user, org.apache.velocity.context.Context context) throws Exception
Exception
public static DisplaySearch getSearch(org.apache.turbine.util.RunData data)
data
- public static void setSearch(org.apache.turbine.util.RunData data, DisplaySearch search)
data
- search
- public static DisplaySearch getDSFromSearchXML(org.apache.turbine.util.RunData data)
public static org.apache.turbine.util.RunData SetSearchProperties(org.apache.turbine.util.RunData data, ItemI item)
public static void SetSearchProperties(org.apache.velocity.context.Context context, ItemI item)
public static ItemI getDataItem(org.apache.turbine.util.RunData data)
public static org.apache.turbine.util.RunData setDataItem(org.apache.turbine.util.RunData data, ItemI item)
public static String getStoredElementName(org.apache.turbine.util.RunData data)
public static void setStoredElementName(org.apache.turbine.util.RunData data, String elementName)
public static void OutputDataParameters(org.apache.turbine.util.RunData data)
public static List<String> GetDataParameterList(org.apache.turbine.util.RunData data)
public static Map<String,String> GetDataParameterHash(org.apache.turbine.util.RunData data)
public static Map<String,String> GetContextParameterHash(org.apache.velocity.context.Context context)
public static Map<String,String> GetTurbineParameters(org.apache.turbine.util.RunData data, org.apache.velocity.context.Context context)
public static void OutputGroupFields(org.apache.turbine.services.intake.model.Group group)
group
- public static void OutputContextParameters(org.apache.velocity.context.Context context)
context
- public static void OutputSessionParameters(org.apache.turbine.util.RunData data)
public static void OutputPassedParameters(org.apache.turbine.util.RunData data, org.apache.velocity.context.Context context, String name)
public static boolean HasPassedParameter(String s, org.apache.turbine.util.RunData data)
public static Object GetPassedParameter(String s, org.apache.turbine.util.RunData data)
public static Boolean GetPassedBoolean(String s, org.apache.turbine.util.RunData data)
public static Integer GetPassedInteger(String s, org.apache.turbine.util.RunData data)
public static Integer GetPassedInteger(String s, org.apache.turbine.util.RunData data, Integer defualt)
public static Object[] GetPassedObjects(String s, org.apache.turbine.util.RunData data)
public static Collection<String> GetPassedStrings(String s, org.apache.turbine.util.RunData data)
public static Object GetPassedParameter(String s, org.apache.turbine.util.RunData data, Object defaultValue)
public static void InstanciatePassedItemForScreenUse(org.apache.turbine.util.RunData data, org.apache.velocity.context.Context context)
public static SimpleDateFormat getDateFormatter()
public static SimpleDateFormat getDateTimeFormatter()
public static SimpleDateFormat getDateTimeSecondsFormatter()
public static SimpleDateFormat getTimeFormatter()
public boolean templateExists(String screen)
public String getProjectDisplayID(Object objectModel, Object project)
objectModel
- The object model.project
- The project.public String getProjectDisplayID(Object objectModel, String projectId)
objectModel
- The object model.projectId
- The project ID.public String getProjectName(Object objectModel, String projectId)
objectModel
- The object model.projectId
- The project ID.public List<Properties> getTemplates(String subFolder)
subFolder
- : like topBar/adminpublic List<Properties> getTemplates(String dataType, String subFolder)
dataType
- The data type.subFolder
- The subfolder.public String getTemplateName(String module, String dataType, String project, String subFolder)
public static Object unescapeParam(Object o)
o
- The object to be unescaped.public int getYear()
public static void setContentDisposition(javax.servlet.http.HttpServletResponse response, String filename)
setContentDisposition(javax.servlet.http.HttpServletResponse, String, boolean)
.response
- The servlet response on which the header should be set.filename
- The suggested filename for downloaded content.public static void setContentDisposition(javax.servlet.http.HttpServletResponse response, String filename, boolean isAttachment)
setContentDisposition(HttpServletResponse, String)
.response
- The servlet response on which the header should be set.filename
- The suggested filename for downloaded content.isAttachment
- Indicates whether the content is an attachment or inline.public static String createContentDispositionValue(String filename, boolean isAttachment)
filename
- The filename for the header.isAttachment
- Whether the content is an attachment or inline.Copyright © 2015 Neuroinformatics Research Group. All rights reserved.