Android Transformer

Additional

Language
Java
Version
Version_1.1.1 (Feb 19, 2015)
Created
Jan 27, 2015
Updated
Mar 18, 2016 (Retired)
Owner
Txus Ballesteros (txusballesteros)
Contributors
Txus Ballesteros (txusballesteros)
Christian Panadero (PaNaVTEC)
Antonio López Marín (tonilopezmr)
3
Activity
Badge
Generate
Download
Source code

Advertising

Android Transformer

Android Transformer It's a Java library to manage your object transformations between your POJO objects.

Version

How to use

Add the library dependency to your build.gradle file.

dependencies {
    ...
    compile 'com.mobandme:android-transformer:1.2'
    provided 'com.mobandme:android-transformer-compiler:1.2'
}

If you are using any other libraries with AnnotationsProcessors like ButterKnife, Realm, etc... You need to set this in your build.gradle to exclude the Processor that is already packaged:

packagingOptions {
    exclude 'META-INF/services/javax.annotation.processing.Processor'
}

Use @Mappable annotation on your class definitions and @Mapped on the fields that you want map to the destination object. See that you destination object type is defined by the 'with' configuration on @Mappable annotation.

IMPORTANT, You don't need configure nothing on your destination classes because the library made this job to you.

@Mappable( with = Home.class )
class HomeModel {

    @Mapped
    public String Address;
    
    // If your objects does not contains the same names into their fields,
    // you can configure the destiny name using the 'toField' parameter.
    @Mapped ( toField = "PostalCode")
    public String CityCode;
    ...

}
class Home {

    public String Address;
    
    public String PostalCode;
    ...

}

And now you will can make your object conversion.

public class MainActivity extends Activity {
    
    private void MyMethod(HomeModel model) {
        //Build your Class transformer.
        Transformer homeModelTransformer = new Transformer
                                                    .Builder()
                                                        .build(HomeModel.class);

        ...
        
        //Converting your Model objects to your Domain objects.
        Home home = (Home)homeModelTransformer.transform(model);
        
        //If you don't like castings between your objects, you can use this.
        Home home = homeModelTransformer.transform(model, Home.class);
        
        ...
        
        //Converting your Domain objects to your Model objects.
        HomeModel homeModel = (HomeModel)homeModelTransformer.transform(home);
        
        //If you don't like castings between your objects, you can use this.
        HomeModel homeModel = homeModelTransformer.transform(home, HomeModel.class);
        ...
    }
}

Using Custom Parsers

Imagine that you need make complex conversions between your objects, for example, you have a entity on your model with a field of String type, and on the other hand you have a Calendar type field on your Domain objects. Now, you can configure your customs data parsers and personalize this conversions.

First, create your custom data parsers, IMPORTANT, you need the in-out data parsers, I mean, if you want convert a String to a Calendar, you need a parser to convert Calendar to String.

public class CalendarToStringParser extends AbstractParser<Calendar, String> {
    
    @Override
    protected String onParse(Calendar value) {
        SimpleDateFormat dateFormatter = new SimpleDateFormat("yyyy-MM-dd");
        return dateFormatter.format(value.getTime());
    }
}
public class StringToCalendarParser extends AbstractParser<String, Calendar> {
    @Override
    protected Calendar onParse(String value) {
        Calendar calendar = GregorianCalendar.getInstance();

        try {
            SimpleDateFormat dateFormatter = new SimpleDateFormat("yyyy-MM-dd");
            calendar.setTime(dateFormatter.parse(value));
        } catch (ParseException e) { }

        return calendar;
    }
}

Now, you need configure this parsers into your fields.

@Mappable( with = Home.class )
public class HomeModel {

    ...
    
    @Parse(
        originToDestinationWith = CalendarToStringParser.class,
        destinationToOriginWith = StringToCalendarParser.class
    )
    @Mapped public Calendar Date;
    
    ...
    
}

License

Copyright Txus Ballesteros 2015 (@txusballesteros)

This file is part of some open source application.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Contact: Txus Ballesteros txus.ballesteros@gmail.com