https://github.com/nikiforovall/sf-mapper
A convention-based object-object mapper for SF :cloud:
https://github.com/nikiforovall/sf-mapper
apex json mapper salesforce sf-mapper sobject
Last synced: about 1 month ago
JSON representation
A convention-based object-object mapper for SF :cloud:
- Host: GitHub
- URL: https://github.com/nikiforovall/sf-mapper
- Owner: NikiforovAll
- License: mit
- Created: 2017-07-02T13:02:57.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-19T16:36:03.000Z (over 7 years ago)
- Last Synced: 2025-02-28T08:33:51.253Z (about 2 months ago)
- Topics: apex, json, mapper, salesforce, sf-mapper, sobject
- Language: Apex
- Homepage:
- Size: 59.6 KB
- Stars: 9
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
SF Mapper
[](https://travis-ci.org/NikiforovAll/SF-Mapper)
==========================
### [What is SF Mapper?](https://github.com/NikiforovAll/SF-Mapper/wiki)
SF Mapper is a simple library build to solve really common problem - getting rid of code that mapped one source object to another sobjects. This type of code is very often mixed with business logic which makes testing and maintaining boring. So why not provide tool to manage this commonplace problem?
### How do I get started?
First, configure SF Mapper. You do it by specifying IFieldMapping object. For example, in listing below we create Account and Contact from Lead.
```java
SObjectMapper.initialize('Lead',
new FieldMapping(
//object mapping
new Map>{
'Account' => new Set{'phone', 'company'},
'Contact' => new Set{'email', 'city'}
},
//field mapping
new Map{
'company' => 'name',
'city' => 'mailingcity',
'phone' => 'phone',
'email' => 'email'
}
)
);
```
Note, FieldMapping is *case-sensitive*. So it's probably better idea to use MapperConfigBuilder, that provides fluent interface to build FieldMapping.
Similar to the code above:
```java
SObjectMapper.initialize(
new MapperConfigBuilder('Lead')
.addObjectMapping('Account', new List{'Phone', 'Company'})
.addObjectMapping('Contact', new List{'Email', 'City'})
.addFieldMapping('Company', 'Name')
.addFieldMapping('City', 'MailingCity')
.addFieldMapping('Phone', 'Phone')
.addFieldMapping('Email', 'Email')
);
// OR
SObjectMapper.initialize(
new MapperConfigBuilder('Lead')
.addObjectMapping('Account', '*') // default mapping object
.addObjectMapping('Contact', new List{'Email', 'City'})
.addFieldMapping('Company', 'Name')
.addFieldMapping('City', 'MailingCity')
.addFieldMapping('Phone', 'Phone')
.addFieldMapping('Email', 'Email')
);
// OR (If you want add field formatting, please see wiki for details)
SObjectMapper.initialize(
new MapperConfigBuilder('Lead')
.addObjectMapping('Account', '*') // default mapping object
.addObjectMapping('Contact', new List{'Email', 'City'})
.addFieldMapping(new FieldMappingRule('Company','Name', 'Account', new MyCustomIFieldFormatter()))
.addFieldMapping('City', 'MailingCity')
);
```
Then in your application code, execute the mappings:
```java
Map result = SObjectMapper.mapObject(lead);
// OR
Map result = SObjectMapper.mapObject(
// anything that implements IResourceProvider (e.g SObjectResourceProvider, JsonResourceProvider)
new SObjectResourceProvider(lead)
);
// OR
Map result = SObjectMapper.mapObject(
new SObjectResourceProvider(lead, 'Lead') // scheme name
);
```
Also, you can map json to SObjects.
**For more details please see**: [getting started guide](https://github.com/NikiforovAll/SF-Mapper/wiki/Getting-started).
### What can I map?
You can take as initial resource pretty much everything that implements *IResourceProviderInterface*.
But SObject to SObjects and JSON to SObjects supported out of the box.
### Where can I get it?
You can use awesome sf deployment tool [githubsfdeploy](https://github.com/afawcett/githubsfdeploy).
### Issues?
Feel free to [ask](https://github.com/NikiforovAll/SF-Mapper/issues).