org.openmrs.util

Class OpenmrsUtil

java.lang.Object

org.openmrs.util.OpenmrsUtil

public class OpenmrsUtil
extends java.lang.Object

Utility methods used in openmrs

Constructor Summary

Constructors

Constructor and Description
OpenmrsUtil()

Method Summary

Modifier and Type	Method and Description
static <K,V> void	addToListMap(java.util.Map<K,java.util.List<V>> map, K key, V obj)
static <K,V> void	addToSetMap(java.util.Map<K,java.util.Set<V>> map, K key, V obj) Allows easy manipulation of a Map
static java.lang.Integer	ageFromBirthdate(java.util.Date birthdate) Deprecated. this method is not currently used within OpenMRS and is a duplicate of Person.getAge(Date)
static void	applyLogLevel(java.lang.String logClass, java.lang.String logLevel) Set the log4j log level for class logClass to logLevel.
static void	applyLogLevels() Set the org.openmrs log4j logger's level if global property log.level.openmrs ( OpenmrsConstants.GLOBAL_PROPERTY_LOG_LEVEL ) exists.
static void	closeStream(java.io.Closeable closableStream) A null-safe and exception safe way to close an inputstream or an outputstream
static boolean	collectionContains(java.util.Collection<?> objects, java.lang.Object obj) Loops over the collection to check to see if the given object is in that collection.
static int	compare(java.util.Date d1, java.util.Date d2) Compares two java.util.Date objects, but handles java.sql.Timestamp (which is not directly comparable to a date) by dropping its nanosecond value.
static <E> java.util.Collection<java.util.Collection<E>>	compareLists(java.util.Collection<E> origList, java.util.Collection<E> newList) Compares origList to newList returning map of differences
static int	compareWithNullAsEarliest(java.util.Date d1, java.util.Date d2) Compares two Date/Timestamp objects, treating null as the earliest possible date.
static <E extends java.lang.Comparable<E>> int	compareWithNullAsGreatest(E c1, E c2)
static int	compareWithNullAsLatest(java.util.Date d1, java.util.Date d2) Compares two Date/Timestamp objects, treating null as the earliest possible date.
static <E extends java.lang.Comparable<E>> int	compareWithNullAsLowest(E c1, E c2)
static java.util.List<Concept>	conceptListHelper(java.lang.String descriptor)
static java.util.Set<Concept>	conceptSetHelper(java.lang.String descriptor)
static <T> boolean	containsAny(java.util.Collection<T> collection, java.util.Collection<T> elements)
static boolean	containsDigit(java.lang.String test)
static boolean	containsOnlyDigits(java.lang.String test)
static boolean	containsUpperAndLowerCase(java.lang.String test)
static java.lang.Integer	convertToInteger(java.lang.Long longValue) This method converts the given Long value to an Integer.
static void	copyFile(java.io.InputStream inputStream, java.io.OutputStream outputStream) Copy file from inputStream onto the outputStream inputStream is not closed in this method outputStream /is/ closed at completion of this method
static boolean	deleteDirectory(java.io.File dir) Recursively deletes files in the given dir folder
static java.util.List<Concept>	delimitedStringToConceptList(java.lang.String delimitedString, java.lang.String delimiter) Parses and loads a delimited list of concept ids or names
static java.util.List<Concept>	delimitedStringToConceptList(java.lang.String delimitedString, java.lang.String delimiter, Context context) Deprecated. replaced by delimitedStringToConceptList(String,String)
static java.util.Map<java.lang.String,Concept>	delimitedStringToConceptMap(java.lang.String delimitedString, java.lang.String delimiter)
static java.util.List<java.lang.Integer>	delimitedStringToIntegerList(java.lang.String delimitedString, java.lang.String delimiter)
static java.util.Date	firstSecondOfDay(java.util.Date date) Return a date that is the same day as the passed in date, but the hours and seconds are the earliest possible for that day.
static boolean	folderContains(java.io.File folder, java.lang.String filename) Look for a file named filename in folder
static java.util.Date	fromDateHelper(java.util.Date comparisonDate, java.lang.Integer withinLastDays, java.lang.Integer withinLastMonths, java.lang.Integer untilDaysAgo, java.lang.Integer untilMonthsAgo, java.util.Date sinceDate, java.util.Date untilDate)
static java.lang.String	generateUid() Creates a uid of length 20
static java.lang.String	generateUid(java.lang.Integer size) Creates a relatively acceptable unique string of the give size
static java.lang.String	getApplicationDataDirectory() Returns the application data directory.
static int	getCheckDigit(java.lang.String idWithoutCheckdigit) Deprecated. Use PatientService.getIdentifierValidator(String)
static Concept	getConceptByIdOrName(java.lang.String idOrName)
static java.util.Map<java.lang.String,java.lang.String>	getCorePrivileges() These are the privileges that are required by OpenMRS.
static java.util.Map<java.lang.String,java.lang.String>	getCoreRoles() All roles returned by this method are inserted into the database if they do not exist already.
static java.text.SimpleDateFormat	getDateFormat() Deprecated. use Context.getDateFormat() or #getDateFormat(Context#getLocale()) instead
static java.text.SimpleDateFormat	getDateFormat(java.util.Locale locale) Get the current user's date format Will look similar to "mm-dd-yyyy".
static java.text.SimpleDateFormat	getDateTimeFormat(java.util.Locale locale) Get the current user's datetime format Will look similar to "mm-dd-yyyy hh:mm a".
static java.io.File	getDirectoryInApplicationDataDirectory(java.lang.String folderName) Find the given folderName in the application data directory.
static byte[]	getFileAsBytes(java.io.File file) Return a byte array representation of the given file
static java.lang.String	getFileAsString(java.io.File file) Return a string representation of the given file
static java.util.Date	getLastMomentOfDay(java.util.Date day) Gets the date having the last millisecond of a given day.
static java.lang.String	getMessage(java.lang.String code, java.lang.Object... args) Utility method for getting the translation for the passed code
static java.lang.String	getOpenmrsLogLocation() Returns the location of the OpenMRS log file.
static java.lang.String	getOpenMRSVersionInTestMode() Gets OpenMRS version name under test mode.
static java.io.File	getOutFile(java.io.File dir, java.util.Date date, User user) Gets an out File object.
static java.io.InputStream	getResourceInputStream(java.net.URL url) Opens input stream for given resource.
static java.util.Properties	getRuntimeProperties(java.lang.String applicationName) Finds and loads the runtime properties file for a specific OpenMRS application.
static java.lang.String	getRuntimePropertiesFileNameInTestMode()
static java.lang.String	getRuntimePropertiesFilePathName(java.lang.String applicationName) Gets the full path and name of the runtime properties file.
static org.simpleframework.xml.Serializer	getSerializer() Deprecated. - Use OpenmrsSerializer from Context.getSerializationService.getDefaultSerializer() Note, this uses a different Serialization mechanism, so you may need to use this for conversion
static org.simpleframework.xml.Serializer	getShortSerializer() Deprecated. - Use OpenmrsSerializer from Context.getSerializationService.getDefaultSerializer() Note, this uses a different Serialization mechanism, so you may need to use this for conversion
static java.text.SimpleDateFormat	getTimeFormat(java.util.Locale locale) Get the current user's time format Will look similar to "hh:mm a".
static boolean	isConceptInList(Concept concept, java.util.List<Concept> list)
static java.lang.Boolean	isInAbsoluteNumericRange(java.lang.Float value, ConceptNumeric concept)
static java.lang.Boolean	isInCriticalNumericRange(java.lang.Float value, ConceptNumeric concept)
static java.lang.Boolean	isInNormalNumericRange(java.lang.Float value, ConceptNumeric concept)
static boolean	isShortSerialization(java.util.Map<?,?> sessionMap) Deprecated. - use SerializationService and OpenmrsSerializer implementation for Serialization
static boolean	isStringInArray(java.lang.String str, java.lang.String[] arr)
static boolean	isTestMode() Checks whether the system is running in test mode
static boolean	isValidCheckDigit(java.lang.String id) Deprecated. Should be using PatientService.getIdentifierValidator(String)
static java.lang.Boolean	isValidNumericValue(java.lang.Float value, ConceptNumeric concept)
static <E> java.lang.String	join(java.util.Collection<E> c, java.lang.String separator) Converts a collection to a String with a specified separator between all elements
static java.util.Date	lastSecondOfDay(java.util.Date date) Deprecated. use getLastMomentOfDay(Date)
static void	loadProperties(java.util.Properties props, java.io.File propertyFile) Convenience method used to load properties from the given file.
static void	loadProperties(java.util.Properties props, java.io.InputStream input) Deprecated. use loadProperties(Properties, File)
static <Arg1,Arg2 extends Arg1> boolean	nullSafeEquals(Arg1 d1, Arg2 d2)
static boolean	nullSafeEqualsIgnoreCase(java.lang.String s1, java.lang.String s2) Performs a case insensitive Comparison of two strings taking care of null values
static java.lang.Object	parse(java.lang.String string, java.lang.Class clazz) Takes a String (e.g.
static java.util.Map<java.lang.String,java.lang.String>	parseParameterList(java.lang.String paramList) Takes a String like "size=compact|order=date" and returns a Map from the keys to the values.
static java.lang.String	postToUrl(java.lang.String urlString, java.util.Map<java.lang.String,java.lang.String> dataToPost) Deprecated. use org.openmrs.util.HttpClient
static java.util.Date	safeDate(java.util.Date d1)
static void	saveDocument(org.w3c.dom.Document doc, java.io.File outFile) Save the given xml document to the given outfile
static void	setApplicationDataDirectory(java.lang.String path) Can be used to override default application data directory.
static void	setupLogAppenders() Setup root level log appenders.
static java.lang.String	shortenedStackTrace(java.lang.String stackTrace) Convert a stack trace into a shortened version for easier viewing and data storage, excluding those lines we are least concerned with; should average about 60% reduction in stack trace length
static void	startup(java.util.Properties p) Initialize global settings Find and load modules
static void	storeProperties(java.util.Properties properties, java.io.File file, java.lang.String comment) Convenience method to replace Properties.store(), which isn't UTF-8 compliant NOTE: In Java 6, you will be able to pass the load() and store() methods a UTF-8 Reader/Writer object as an argument, making this method unnecessary.
static void	storeProperties(java.util.Properties properties, java.io.OutputStream outStream, java.lang.String comment) Convenience method to replace Properties.store(), which isn't UTF-8 compliant NOTE: In Java 6, you will be able to pass the load() and store() methods a UTF-8 Reader/Writer object as an argument.
static boolean	stringStartsWith(java.lang.String str, java.lang.String[] prefixes) Tests if the given String starts with any of the specified prefixes
static java.util.Date	toDateHelper(java.util.Date comparisonDate, java.lang.Integer withinLastDays, java.lang.Integer withinLastMonths, java.lang.Integer untilDaysAgo, java.lang.Integer untilMonthsAgo, java.util.Date sinceDate, java.util.Date untilDate)
static PatientFilter	toPatientFilter(PatientSearch search, CohortSearchHistory history) Deprecated. see reportingcompatibility module
static PatientFilter	toPatientFilter(PatientSearch search, CohortSearchHistory history, EvaluationContext evalContext) Deprecated. see reportingcompatibility module
static java.io.File	url2file(java.net.URL url) Utility method to convert local URL to a File object.
static void	validateJavaVersion() Checks whether the current JVM version is at least Java 6.
static void	validatePassword(java.lang.String username, java.lang.String password, java.lang.String systemId) Utility to check the validity of a password for a certain User.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenmrsUtil

public OpenmrsUtil()

Method Detail

getCheckDigit

@Deprecated
public static int getCheckDigit(java.lang.String idWithoutCheckdigit)
                                     throws java.lang.Exception

Deprecated. Use PatientService.getIdentifierValidator(String)

Parameters:

idWithoutCheckdigit -

Returns:

int - the calculated check digit for the given string

Throws:

java.lang.Exception

isValidCheckDigit

@Deprecated
public static boolean isValidCheckDigit(java.lang.String id)
                                             throws java.lang.Exception

Deprecated. Should be using PatientService.getIdentifierValidator(String)

Parameters:

id -

Returns:

true/false whether id has a valid check digit

Throws:

java.lang.Exception - on invalid characters and invalid id formation

compareLists

public static <E> java.util.Collection<java.util.Collection<E>> compareLists(java.util.Collection<E> origList,
                                                                             java.util.Collection<E> newList)

Compares origList to newList returning map of differences

Parameters:

origList -

newList -

Returns:

[List toAdd, List toDelete] with respect to origList

isStringInArray

public static boolean isStringInArray(java.lang.String str,
                                      java.lang.String[] arr)

isInNormalNumericRange

public static java.lang.Boolean isInNormalNumericRange(java.lang.Float value,
                                                       ConceptNumeric concept)

isInCriticalNumericRange

public static java.lang.Boolean isInCriticalNumericRange(java.lang.Float value,
                                                         ConceptNumeric concept)

isInAbsoluteNumericRange

public static java.lang.Boolean isInAbsoluteNumericRange(java.lang.Float value,
                                                         ConceptNumeric concept)

isValidNumericValue

public static java.lang.Boolean isValidNumericValue(java.lang.Float value,
                                                    ConceptNumeric concept)

getFileAsString

public static java.lang.String getFileAsString(java.io.File file)
                                        throws java.io.IOException

Return a string representation of the given file

Parameters:

file -

Returns:

String file contents

Throws:

java.io.IOException

getFileAsBytes

public static byte[] getFileAsBytes(java.io.File file)
                             throws java.io.IOException

Return a byte array representation of the given file

Parameters:

file -

Returns:

byte[] file contents

Throws:

java.io.IOException

copyFile

public static void copyFile(java.io.InputStream inputStream,
                            java.io.OutputStream outputStream)
                     throws java.io.IOException

Copy file from inputStream onto the outputStream inputStream is not closed in this method outputStream /is/ closed at completion of this method

Parameters:

inputStream - Stream to copy from

outputStream - Stream/location to copy to

Throws:

java.io.IOException - thrown if an error occurs during read/write

folderContains

public static boolean folderContains(java.io.File folder,
                                     java.lang.String filename)

Look for a file named filename in folder

Parameters:

folder -

filename -

Returns:

true/false whether filename exists in folder

getCorePrivileges

public static java.util.Map<java.lang.String,java.lang.String> getCorePrivileges()

These are the privileges that are required by OpenMRS. This looks for privileges marked as AddOnStartup to know which privs, upon startup or loading of a module, to insert into the database if they do not exist already. These privileges are not allowed to be deleted. They are marked as 'locked' in the administration screens.

Returns:

privileges core to the system

See Also:

PrivilegeConstants, Context.checkCoreDataset()

getCoreRoles

public static java.util.Map<java.lang.String,java.lang.String> getCoreRoles()

All roles returned by this method are inserted into the database if they do not exist already. These roles are also forbidden to be deleted from the administration screens.

Returns:

roles that are core to the system

startup

public static void startup(java.util.Properties p)

Initialize global settings Find and load modules

Parameters:

p - properties from runtime configuration

applyLogLevels

public static void applyLogLevels()

Set the org.openmrs log4j logger's level if global property log.level.openmrs ( OpenmrsConstants.GLOBAL_PROPERTY_LOG_LEVEL ) exists. Valid values for global property are trace, debug, info, warn, error or fatal.

setupLogAppenders

public static void setupLogAppenders()

Setup root level log appenders.

Since:

1.9.2

applyLogLevel

public static void applyLogLevel(java.lang.String logClass,
                                 java.lang.String logLevel)

Set the log4j log level for class logClass to logLevel.

Parameters:

logClass - optional string giving the class level to change. Defaults to OpenmrsConstants.LOG_CLASS_DEFAULT . Should be something like org.openmrs.___

logLevel - one of OpenmrsConstants.LOG_LEVEL_*

parseParameterList

public static java.util.Map<java.lang.String,java.lang.String> parseParameterList(java.lang.String paramList)

Takes a String like "size=compact|order=date" and returns a Map from the keys to the values.

Parameters:

paramList - String with a list of parameters

Returns:

Map of the parameters passed

nullSafeEquals

public static <Arg1,Arg2 extends Arg1> boolean nullSafeEquals(Arg1 d1,
                                                              Arg2 d2)

compare

public static int compare(java.util.Date d1,
                          java.util.Date d2)

Compares two java.util.Date objects, but handles java.sql.Timestamp (which is not directly comparable to a date) by dropping its nanosecond value.

compareWithNullAsEarliest

public static int compareWithNullAsEarliest(java.util.Date d1,
                                            java.util.Date d2)

Compares two Date/Timestamp objects, treating null as the earliest possible date.

compareWithNullAsLatest

public static int compareWithNullAsLatest(java.util.Date d1,
                                          java.util.Date d2)

Compares two Date/Timestamp objects, treating null as the earliest possible date.

compareWithNullAsLowest

public static <E extends java.lang.Comparable<E>> int compareWithNullAsLowest(E c1,
                                                                              E c2)

compareWithNullAsGreatest

public static <E extends java.lang.Comparable<E>> int compareWithNullAsGreatest(E c1,
                                                                                E c2)

ageFromBirthdate

@Deprecated
public static java.lang.Integer ageFromBirthdate(java.util.Date birthdate)

Deprecated. this method is not currently used within OpenMRS and is a duplicate of Person.getAge(Date)

join

public static <E> java.lang.String join(java.util.Collection<E> c,
                                        java.lang.String separator)

Converts a collection to a String with a specified separator between all elements

Parameters:

c - Collection to be joined

separator - string to put between all elements

Returns:

a String representing the toString() of all elements in c, separated by separator

conceptSetHelper

public static java.util.Set<Concept> conceptSetHelper(java.lang.String descriptor)

delimitedStringToConceptList

@Deprecated
public static java.util.List<Concept> delimitedStringToConceptList(java.lang.String delimitedString,
                                                                               java.lang.String delimiter,
                                                                               Context context)

Deprecated. replaced by delimitedStringToConceptList(String,String)

Also see TRUNK-3665

delimitedStringToConceptList

public static java.util.List<Concept> delimitedStringToConceptList(java.lang.String delimitedString,
                                                                   java.lang.String delimiter)

Parses and loads a delimited list of concept ids or names

Parameters:

delimitedString - the delimited list of concept ids or names

delimiter - the delimiter, e.g. ","

Returns:

the list of concepts

Since:

1.10, 1.9.2, 1.8.5

delimitedStringToConceptMap

public static java.util.Map<java.lang.String,Concept> delimitedStringToConceptMap(java.lang.String delimitedString,
                                                                                  java.lang.String delimiter)

getConceptByIdOrName

public static Concept getConceptByIdOrName(java.lang.String idOrName)

conceptListHelper

public static java.util.List<Concept> conceptListHelper(java.lang.String descriptor)

lastSecondOfDay

@Deprecated
public static java.util.Date lastSecondOfDay(java.util.Date date)

Deprecated. use getLastMomentOfDay(Date)

Return a date that is the same day as the passed in date, but the hours and seconds are the latest possible for that day.

Parameters:

date - date to adjust

Returns:

a date that is the last possible time in the day

getLastMomentOfDay

public static java.util.Date getLastMomentOfDay(java.util.Date day)

Gets the date having the last millisecond of a given day. Meaning that the hours, seconds, and milliseconds are the latest possible for that day.

Parameters:

day - the day.

Returns:

the date with the last millisecond of the day.

firstSecondOfDay

public static java.util.Date firstSecondOfDay(java.util.Date date)

Return a date that is the same day as the passed in date, but the hours and seconds are the earliest possible for that day.

Parameters:

date - date to adjust

Returns:

a date that is the first possible time in the day

Since:

1.9

safeDate

public static java.util.Date safeDate(java.util.Date d1)

deleteDirectory

public static boolean deleteDirectory(java.io.File dir)
                               throws java.io.IOException

Recursively deletes files in the given dir folder

Parameters:

dir - File directory to delete

Returns:

true/false whether the delete was completed successfully

Throws:

java.io.IOException - if dir is not a directory

url2file

public static java.io.File url2file(java.net.URL url)

Utility method to convert local URL to a File object.

Parameters:

url - an URL

Returns:

file object for given URL or null if URL is not local

getResourceInputStream

public static java.io.InputStream getResourceInputStream(java.net.URL url)
                                                  throws java.io.IOException

Opens input stream for given resource. This method behaves differently for different URL types:

• for local files it returns buffered file input stream;
• for local JAR files it reads resource content into memory buffer and returns byte array input stream that wraps those buffer (this prevents locking JAR file);
• for common URL's this method simply opens stream to that URL using standard URL API.

It is not recommended to use this method for big resources within JAR files.

Parameters:

url - resource URL

Returns:

input stream for given resource

Throws:

java.io.IOException - if any I/O error has occurred

getApplicationDataDirectory

public static java.lang.String getApplicationDataDirectory()

 Returns the application data directory. Searches for the value first 
 in the "application_data_directory" runtime property, then in the servlet
 init parameter "application.data.directory." If not found, returns:
 a) "{user.home}/.OpenMRS" on UNIX-based systems
 b) "{user.home}\Application Data\OpenMRS" on Windows
 
 Path can be set via systemproperty OPENMRS_APPLICATION_DATA_DIRECTORY
 for development purposes.
 

Returns:

The path to the directory on the file system that will hold miscellaneous data about the application (runtime properties, modules, etc)

setApplicationDataDirectory

public static void setApplicationDataDirectory(java.lang.String path)

Can be used to override default application data directory.

Note that it will not override application data directory provided as a system property.

Parameters:

path -

Since:

1.11

getOpenmrsLogLocation

public static java.lang.String getOpenmrsLogLocation()

Returns the location of the OpenMRS log file.

Returns:

the path to the OpenMRS log file

Since:

1.9.2

validateJavaVersion

public static void validateJavaVersion()

Checks whether the current JVM version is at least Java 6.

Throws:

org.springframework.context.ApplicationContextException - if the current JVM version is earlier than Java 6

getDirectoryInApplicationDataDirectory

public static java.io.File getDirectoryInApplicationDataDirectory(java.lang.String folderName)
                                                           throws APIException

Find the given folderName in the application data directory. Or, treat folderName like an absolute url to a directory

Parameters:

folderName -

Returns:

folder capable of storing information

Throws:

APIException

saveDocument

public static void saveDocument(org.w3c.dom.Document doc,
                                java.io.File outFile)

Save the given xml document to the given outfile

Parameters:

doc - Document to be saved

outFile - file pointer to the location the xml file is to be saved to

delimitedStringToIntegerList

public static java.util.List<java.lang.Integer> delimitedStringToIntegerList(java.lang.String delimitedString,
                                                                             java.lang.String delimiter)

stringStartsWith

public static boolean stringStartsWith(java.lang.String str,
                                       java.lang.String[] prefixes)

Tests if the given String starts with any of the specified prefixes

Parameters:

str - the string to test

prefixes - an array of prefixes to test against

Returns:

true if the String starts with any of the specified prefixes, otherwise false.

isConceptInList

public static boolean isConceptInList(Concept concept,
                                      java.util.List<Concept> list)

fromDateHelper

public static java.util.Date fromDateHelper(java.util.Date comparisonDate,
                                            java.lang.Integer withinLastDays,
                                            java.lang.Integer withinLastMonths,
                                            java.lang.Integer untilDaysAgo,
                                            java.lang.Integer untilMonthsAgo,
                                            java.util.Date sinceDate,
                                            java.util.Date untilDate)

toDateHelper

public static java.util.Date toDateHelper(java.util.Date comparisonDate,
                                          java.lang.Integer withinLastDays,
                                          java.lang.Integer withinLastMonths,
                                          java.lang.Integer untilDaysAgo,
                                          java.lang.Integer untilMonthsAgo,
                                          java.util.Date sinceDate,
                                          java.util.Date untilDate)

containsAny

public static <T> boolean containsAny(java.util.Collection<T> collection,
                                      java.util.Collection<T> elements)

Parameters:

collection -

elements -

Returns:

Whether _collection_ contains any of _elements_

addToSetMap

public static <K,V> void addToSetMap(java.util.Map<K,java.util.Set<V>> map,
                                     K key,
                                     V obj)

Allows easy manipulation of a Map

addToListMap

public static <K,V> void addToListMap(java.util.Map<K,java.util.List<V>> map,
                                      K key,
                                      V obj)

getDateFormat

@Deprecated
public static java.text.SimpleDateFormat getDateFormat()

Deprecated. use Context.getDateFormat() or #getDateFormat(Context#getLocale()) instead

Get the current user's date format Will look similar to "mm-dd-yyyy". Depends on user's locale.

Returns:

a simple date format

getDateFormat

public static java.text.SimpleDateFormat getDateFormat(java.util.Locale locale)

Get the current user's date format Will look similar to "mm-dd-yyyy". Depends on user's locale.

Returns:

a simple date format

Since:

1.5

getTimeFormat

public static java.text.SimpleDateFormat getTimeFormat(java.util.Locale locale)

Get the current user's time format Will look similar to "hh:mm a". Depends on user's locale.

Returns:

a simple time format

Since:

1.9

getDateTimeFormat

public static java.text.SimpleDateFormat getDateTimeFormat(java.util.Locale locale)

Get the current user's datetime format Will look similar to "mm-dd-yyyy hh:mm a". Depends on user's locale.

Returns:

a simple date format

Since:

1.9

toPatientFilter

@Deprecated
public static PatientFilter toPatientFilter(PatientSearch search,
                                                        CohortSearchHistory history)

Deprecated. see reportingcompatibility module

parse

public static java.lang.Object parse(java.lang.String string,
                                     java.lang.Class clazz)

Takes a String (e.g. a user-entered one) and parses it into an object of the specified class

Parameters:

string -

clazz -

Returns:

Object of type clazz with the data from string

toPatientFilter

@Deprecated
public static PatientFilter toPatientFilter(PatientSearch search,
                                                        CohortSearchHistory history,
                                                        EvaluationContext evalContext)

Deprecated. see reportingcompatibility module

Uses reflection to translate a PatientSearch into a PatientFilter

collectionContains

public static boolean collectionContains(java.util.Collection<?> objects,
                                         java.lang.Object obj)

Loops over the collection to check to see if the given object is in that collection. This method only uses the .equals() method for comparison. This should be used in the patient/person objects on their collections. Their collections are SortedSets which use the compareTo method for equality as well. The compareTo method is currently optimized for sorting, not for equality. A null obj will return false

Parameters:

objects - collection to loop over

obj - Object to look for in the objects

Returns:

true/false whether the given object is found

getSerializer

@Deprecated
public static org.simpleframework.xml.Serializer getSerializer()

Deprecated. - Use OpenmrsSerializer from Context.getSerializationService.getDefaultSerializer() Note, this uses a different Serialization mechanism, so you may need to use this for conversion

Get a serializer that will do the common type of serialization and deserialization. Cycles of objects are taken into account

Returns:

Serializer to do the (de)serialization

getShortSerializer

@Deprecated
public static org.simpleframework.xml.Serializer getShortSerializer()

Deprecated. - Use OpenmrsSerializer from Context.getSerializationService.getDefaultSerializer() Note, this uses a different Serialization mechanism, so you may need to use this for conversion

Get a short serializer that will only do the very basic serialization necessary. This is controlled by the objects that are being serialized via the @Replace methods

Returns:

Serializer to do the short (de)serialization

See Also:

OpenmrsConstants.SHORT_SERIALIZATION

isShortSerialization

@Deprecated
public static boolean isShortSerialization(java.util.Map<?,?> sessionMap)

Deprecated. - use SerializationService and OpenmrsSerializer implementation for Serialization

True/false whether the current serialization is supposed to be a short serialization. A shortened serialization This should be called from methods marked with the @Replace notation that take in a single Map parameter.

Parameters:

sessionMap - current serialization session

Returns:

true/false whether or not to do the shortened serialization

getOutFile

public static java.io.File getOutFile(java.io.File dir,
                                      java.util.Date date,
                                      User user)

Gets an out File object. If date is not provided, the current timestamp is used. If user is not provided, the user id is not put into the filename. Assumes dir is already created

Parameters:

dir - directory to make the random filename in

date - optional Date object used for the name

user - optional User creating this file object

Returns:

file new file that is able to be written to

generateUid

public static java.lang.String generateUid(java.lang.Integer size)

Creates a relatively acceptable unique string of the give size

Returns:

unique string

generateUid

public static java.lang.String generateUid()

Creates a uid of length 20

See Also:

generateUid(Integer)

postToUrl

@Deprecated
public static java.lang.String postToUrl(java.lang.String urlString,
                                                     java.util.Map<java.lang.String,java.lang.String> dataToPost)

Deprecated. use org.openmrs.util.HttpClient

Post the given map of variables to the given url string

Parameters:

urlString - valid http url to post data to

dataToPost - Map of key value pairs to post to urlString

Returns:

response from urlString after posting

storeProperties

public static void storeProperties(java.util.Properties properties,
                                   java.io.File file,
                                   java.lang.String comment)

Convenience method to replace Properties.store(), which isn't UTF-8 compliant
NOTE: In Java 6, you will be able to pass the load() and store() methods a UTF-8 Reader/Writer object as an argument, making this method unnecessary.

Parameters:

properties -

file -

comment -

storeProperties

public static void storeProperties(java.util.Properties properties,
                                   java.io.OutputStream outStream,
                                   java.lang.String comment)

Convenience method to replace Properties.store(), which isn't UTF-8 compliant NOTE: In Java 6, you will be able to pass the load() and store() methods a UTF-8 Reader/Writer object as an argument.

Parameters:

properties -

file -

comment - (which appears in comments in properties file)

loadProperties

public static void loadProperties(java.util.Properties props,
                                  java.io.InputStream input)

Deprecated. use loadProperties(Properties, File)

This method is a replacement for Properties.load(InputStream) so that we can load in utf-8 characters. Currently the load method expects the inputStream to point to a latin1 encoded file.
NOTE: In Java 6, you will be able to pass the load() and store() methods a UTF-8 Reader/Writer object as an argument, making this method unnecessary.

Parameters:

props - the properties object to write into

input - the input stream to read from

loadProperties

public static void loadProperties(java.util.Properties props,
                                  java.io.File propertyFile)

Convenience method used to load properties from the given file.

Parameters:

props - the properties object to be loaded into

propertyFile - the properties file to read

getMessage

public static java.lang.String getMessage(java.lang.String code,
                                          java.lang.Object... args)

Utility method for getting the translation for the passed code

Parameters:

code - the message key to lookup

args - the replacement values for the translation string

Returns:

the message, or if not found, the code

validatePassword

public static void validatePassword(java.lang.String username,
                                    java.lang.String password,
                                    java.lang.String systemId)
                             throws PasswordException

Utility to check the validity of a password for a certain User. Passwords must be non-null. Their required strength is configured via global properties:

Description	Property	Default Value
Require that it not match the User's username or system id	OpenmrsConstants.GP_PASSWORD_CANNOT_MATCH_USERNAME_OR_SYSTEMID	true
Require a minimum length	OpenmrsConstants.GP_PASSWORD_MINIMUM_LENGTH	8
Require both an upper and lower case character	OpenmrsConstants.GP_PASSWORD_REQUIRES_UPPER_AND_LOWER_CASE	true
Require at least one numeric character	OpenmrsConstants.GP_PASSWORD_REQUIRES_DIGIT	true
Require at least one non-numeric character	OpenmrsConstants.GP_PASSWORD_REQUIRES_NON_DIGIT	true
Require a match on the specified regular expression	OpenmrsConstants.GP_PASSWORD_CUSTOM_REGEX	null

Parameters:

username - user name of the user with password to validated

password - string that will be validated

systemId - system id of the user with password to be validated

Throws:

PasswordException

Since:

1.5

containsUpperAndLowerCase

public static boolean containsUpperAndLowerCase(java.lang.String test)

Parameters:

test - the string to test

Returns:

true if the passed string contains both upper and lower case characters

containsOnlyDigits

public static boolean containsOnlyDigits(java.lang.String test)

Parameters:

test - the string to test

Returns:

true if the passed string contains only numeric characters

containsDigit

public static boolean containsDigit(java.lang.String test)

Parameters:

test - the string to test

Returns:

true if the passed string contains any numeric characters

closeStream

public static void closeStream(java.io.Closeable closableStream)

A null-safe and exception safe way to close an inputstream or an outputstream

Parameters:

closableStream - an InputStream or OutputStream to close

shortenedStackTrace

public static java.lang.String shortenedStackTrace(java.lang.String stackTrace)

Convert a stack trace into a shortened version for easier viewing and data storage, excluding those lines we are least concerned with; should average about 60% reduction in stack trace length

Parameters:

stackTrace - original stack trace from an error

Returns:

shortened stack trace

Since:

1.7

getRuntimeProperties

public static java.util.Properties getRuntimeProperties(java.lang.String applicationName)

 Finds and loads the runtime properties file for a specific OpenMRS application.
 Searches for the file in this order:
 1) {current directory}/{applicationname}_runtime.properties
 2) an environment variable called "{APPLICATIONNAME}_RUNTIME_PROPERTIES_FILE"
 3) {openmrs_app_dir}/{applicationName}_runtime.properties   // openmrs_app_dir is typically {user_home}/.OpenMRS
 

Parameters:

applicationName - (defaults to "openmrs") the name of the running OpenMRS application, e.g. if you have deployed OpenMRS as a web application you would give the deployed context path here

Returns:

runtime properties, or null if none can be found

Since:

1.8

See Also:

getApplicationDataDirectory()

isTestMode

public static boolean isTestMode()

Checks whether the system is running in test mode

Returns:

boolean

getRuntimePropertiesFilePathName

public static java.lang.String getRuntimePropertiesFilePathName(java.lang.String applicationName)

Gets the full path and name of the runtime properties file.

Parameters:

applicationName - (defaults to "openmrs") the name of the running OpenMRS application, e.g. if you have deployed OpenMRS as a web application you would give the deployed context path here

Returns:

runtime properties file path and name, or null if none can be found

Since:

1.9

getRuntimePropertiesFileNameInTestMode

public static java.lang.String getRuntimePropertiesFileNameInTestMode()

getOpenMRSVersionInTestMode

public static java.lang.String getOpenMRSVersionInTestMode()

Gets OpenMRS version name under test mode.

Returns:

String openmrs version number

nullSafeEqualsIgnoreCase

public static boolean nullSafeEqualsIgnoreCase(java.lang.String s1,
                                               java.lang.String s2)

Performs a case insensitive Comparison of two strings taking care of null values

Parameters:

s1 - the string to compare

s2 - the string to compare

Returns:

Since:

1.8

convertToInteger

public static java.lang.Integer convertToInteger(java.lang.Long longValue)

This method converts the given Long value to an Integer. If the Long value will not fit in an Integer an exception is thrown

Parameters:

longValue - the value to convert

Returns:

the long value in integer form.

Throws:

java.lang.IllegalArgumentException - if the long value does not fit into an integer