dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #35697
[Branch ~dhis2-devs-core/dhis2/trunk] Rev 18269: add TranslationOption bean to enable easy access to translation parameters
------------------------------------------------------------
revno: 18269
committer: Morten Olav Hansen <mortenoh@xxxxxxxxx>
branch nick: dhis2
timestamp: Mon 2015-02-16 10:56:25 +0700
message:
add TranslationOption bean to enable easy access to translation parameters
added:
dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/metadata/TranslateOptions.java
modified:
dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/BaseIdentifiableObject.java
dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/metadata/Options.java
dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/AbstractCrudController.java
dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/MessageConversationController.java
--
lp:dhis2
https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk
Your team DHIS 2 developers is subscribed to branch lp:dhis2.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk/+edit-subscription
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/BaseIdentifiableObject.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/BaseIdentifiableObject.java 2015-02-05 06:53:38 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/common/BaseIdentifiableObject.java 2015-02-16 03:56:25 +0000
@@ -351,7 +351,7 @@
}
@Override
- @JsonView( { DimensionalView.class } )
+ @JsonView( { DetailedView.class, DimensionalView.class } )
@JsonProperty
@JacksonXmlProperty( namespace = DxfNamespaces.DXF_2_0 )
public String getDisplayName()
=== modified file 'dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/metadata/Options.java'
--- dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/metadata/Options.java 2015-02-16 03:09:23 +0000
+++ dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/metadata/Options.java 2015-02-16 03:56:25 +0000
@@ -139,10 +139,6 @@
protected boolean assumeTrue;
- protected boolean translate;
-
- protected String locale;
-
//--------------------------------------------------------------------------
// Constructors
//--------------------------------------------------------------------------
@@ -151,8 +147,6 @@
{
this.options = options;
this.assumeTrue = options.get( "assumeTrue" ) == null || options.get( "assumeTrue" ).equalsIgnoreCase( "true" );
- this.locale = options.get( "locale" );
- this.translate = isEnabled( "translate" ) || !StringUtils.isEmpty( locale );
}
public Options()
@@ -257,21 +251,6 @@
this.assumeTrue = assumeTrue;
}
- public boolean isTranslate()
- {
- return translate;
- }
-
- public boolean defaultLocale()
- {
- return StringUtils.isEmpty( locale );
- }
-
- public Locale getLocale()
- {
- return Locale.forLanguageTag( locale );
- }
-
//--------------------------------------------------------------------------
// Getters for standard options
//--------------------------------------------------------------------------
=== added file 'dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/metadata/TranslateOptions.java'
--- dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/metadata/TranslateOptions.java 1970-01-01 00:00:00 +0000
+++ dhis-2/dhis-services/dhis-service-dxf2/src/main/java/org/hisp/dhis/dxf2/metadata/TranslateOptions.java 2015-02-16 03:56:25 +0000
@@ -0,0 +1,72 @@
+package org.hisp.dhis.dxf2.metadata;
+
+/*
+ * Copyright (c) 2004-2015, University of Oslo
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * Neither the name of the HISP project nor the names of its contributors may
+ * be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+import org.springframework.util.StringUtils;
+
+import java.util.Locale;
+
+/**
+ * @author Morten Olav Hansen <mortenoh@xxxxxxxxx>
+ */
+public class TranslateOptions
+{
+ private boolean translate;
+
+ private String locale;
+
+ public TranslateOptions()
+ {
+ }
+
+ public boolean isTranslate()
+ {
+ return translate || !StringUtils.isEmpty( locale );
+ }
+
+ public void setTranslate( boolean translate )
+ {
+ this.translate = translate;
+ }
+
+ public Locale getLocale()
+ {
+ return Locale.forLanguageTag( locale );
+ }
+
+ public void setLocale( String locale )
+ {
+ this.locale = locale;
+ }
+
+ public boolean defaultLocale()
+ {
+ return StringUtils.isEmpty( locale );
+ }
+}
=== modified file 'dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/AbstractCrudController.java'
--- dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/AbstractCrudController.java 2015-02-16 03:09:23 +0000
+++ dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/AbstractCrudController.java 2015-02-16 03:56:25 +0000
@@ -42,7 +42,7 @@
import org.hisp.dhis.dxf2.importsummary.ImportStatus;
import org.hisp.dhis.dxf2.metadata.ImportService;
import org.hisp.dhis.dxf2.metadata.ImportTypeSummary;
-import org.hisp.dhis.dxf2.metadata.Options;
+import org.hisp.dhis.dxf2.metadata.TranslateOptions;
import org.hisp.dhis.dxf2.objectfilter.ObjectFilterService;
import org.hisp.dhis.dxf2.render.RenderService;
import org.hisp.dhis.hibernate.exception.CreateAccessDeniedException;
@@ -136,7 +136,7 @@
@RequestMapping( method = RequestMethod.GET )
public @ResponseBody RootNode getObjectList(
- @RequestParam Map<String, String> rpParameters, HttpServletResponse response, HttpServletRequest request )
+ @RequestParam Map<String, String> rpParameters, TranslateOptions translateOptions, HttpServletResponse response, HttpServletRequest request )
{
List<String> fields = Lists.newArrayList( contextService.getParameterValues( "fields" ) );
List<String> filters = Lists.newArrayList( contextService.getParameterValues( "filter" ) );
@@ -219,7 +219,7 @@
Pager pager = metaData.getPager();
entities = objectFilterService.filter( entities, filters );
- translate( entities, options );
+ translate( entities, translateOptions );
if ( hasPaging )
{
@@ -254,7 +254,9 @@
@RequestMapping( value = "/{uid}", method = RequestMethod.GET )
public @ResponseBody RootNode getObject(
- @PathVariable( "uid" ) String pvUid, @RequestParam Map<String, String> rpParameters,
+ @PathVariable( "uid" ) String pvUid,
+ @RequestParam Map<String, String> rpParameters,
+ TranslateOptions translateOptions,
HttpServletRequest request, HttpServletResponse response ) throws Exception
{
List<String> fields = Lists.newArrayList( contextService.getParameterValues( "fields" ) );
@@ -265,12 +267,14 @@
fields.add( ":all" );
}
- return getObjectInternal( pvUid, rpParameters, filters, fields );
+ return getObjectInternal( pvUid, rpParameters, filters, fields, translateOptions );
}
@RequestMapping( value = "/{uid}/{property}", method = RequestMethod.GET )
public @ResponseBody RootNode getObjectProperty(
- @PathVariable( "uid" ) String pvUid, @PathVariable( "property" ) String pvProperty, @RequestParam Map<String, String> rpParameters,
+ @PathVariable( "uid" ) String pvUid, @PathVariable( "property" ) String pvProperty,
+ @RequestParam Map<String, String> rpParameters,
+ TranslateOptions translateOptions,
HttpServletRequest request, HttpServletResponse response ) throws Exception
{
List<String> fields = Lists.newArrayList( contextService.getParameterValues( "fields" ) );
@@ -282,7 +286,7 @@
String fieldFilter = "[" + Joiner.on( ',' ).join( fields ) + "]";
- return getObjectInternal( pvUid, rpParameters, Lists.<String>newArrayList(), Lists.newArrayList( pvProperty + fieldFilter ) );
+ return getObjectInternal( pvUid, rpParameters, Lists.<String>newArrayList(), Lists.newArrayList( pvProperty + fieldFilter ), translateOptions );
}
@RequestMapping( value = "/{uid}/{property}", method = { RequestMethod.PUT, RequestMethod.PATCH } )
@@ -334,17 +338,17 @@
serialize( request, response, summary );
}
- protected void translate( List<T> entities, Options options )
+ protected void translate( List<T> entities, TranslateOptions translate )
{
- if ( options.isTranslate() )
+ if ( translate.isTranslate() )
{
- if ( options.defaultLocale() )
+ if ( translate.defaultLocale() )
{
i18nService.internationalise( entities );
}
else
{
- i18nService.internationalise( entities, options.getLocale() );
+ i18nService.internationalise( entities, translate.getLocale() );
}
}
}
@@ -352,9 +356,19 @@
private RootNode getObjectInternal( String uid, Map<String, String> parameters,
List<String> filters, List<String> fields ) throws Exception
{
+ return getObjectInternal( uid, parameters, filters, fields, null );
+ }
+
+ private RootNode getObjectInternal( String uid, Map<String, String> parameters,
+ List<String> filters, List<String> fields, TranslateOptions translateOptions ) throws Exception
+ {
WebOptions options = new WebOptions( parameters );
List<T> entities = getEntity( uid, options );
- translate( entities, options );
+
+ if ( translateOptions != null )
+ {
+ translate( entities, translateOptions );
+ }
if ( entities.isEmpty() )
{
@@ -562,9 +576,10 @@
@PathVariable( "property" ) String pvProperty,
@PathVariable( "itemId" ) String pvItemId,
@RequestParam Map<String, String> parameters,
+ TranslateOptions translateOptions,
HttpServletRequest request, HttpServletResponse response ) throws Exception
{
- RootNode rootNode = getObjectInternal( pvUid, parameters, Lists.<String>newArrayList(), Lists.newArrayList( pvProperty + "[:all]" ) );
+ RootNode rootNode = getObjectInternal( pvUid, parameters, Lists.<String>newArrayList(), Lists.newArrayList( pvProperty + "[:all]" ), translateOptions );
// TODO optimize this using field filter (collection filtering)
if ( !rootNode.getChildren().isEmpty() && rootNode.getChildren().get( 0 ).isCollection() )
=== modified file 'dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/MessageConversationController.java'
--- dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/MessageConversationController.java 2015-02-10 16:46:23 +0000
+++ dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/MessageConversationController.java 2015-02-16 03:56:25 +0000
@@ -31,6 +31,7 @@
import com.google.common.collect.Lists;
import org.hisp.dhis.acl.AclService;
import org.hisp.dhis.common.Pager;
+import org.hisp.dhis.dxf2.metadata.TranslateOptions;
import org.hisp.dhis.dxf2.utils.JacksonUtils;
import org.hisp.dhis.hibernate.exception.DeleteAccessDeniedException;
import org.hisp.dhis.hibernate.exception.UpdateAccessDeniedException;
@@ -105,7 +106,7 @@
}
@Override
- public RootNode getObject( @PathVariable String uid, Map<String, String> rpParameters, HttpServletRequest request, HttpServletResponse response )
+ public RootNode getObject( @PathVariable String uid, Map<String, String> rpParameters, TranslateOptions translateOptions, HttpServletRequest request, HttpServletResponse response )
throws Exception
{
org.hisp.dhis.message.MessageConversation messageConversation = messageService.getMessageConversation( uid );
@@ -123,7 +124,7 @@
throw new AccessDeniedException( "Not authorized to access this conversation." );
}
- return super.getObject( uid, rpParameters, request, response );
+ return super.getObject( uid, rpParameters, translateOptions, request, response );
}
@Override
