Package io.atlasmap.builder

Class AtlasField

java.lang.Object

io.atlasmap.builder.AtlasField

public class AtlasField
extends Object

A part of custom mapping builder API to implement custom mapping logic in Java code. This class wraps raw Field and provide some utility methods to introspect underlying field tree. DefaultAtlasMappingBuilder.read(String, String) reads from source document and creates AtlasField.

See Also:

DefaultAtlasMappingBuilder

Constructor Summary

Constructors

Constructor	Description
AtlasField(DefaultAtlasSession session)

Method Summary

Modifier and Type	Method	Description
AtlasField	action(String actionName, List<Object> parameters)
io.atlasmap.v2.Field	getRawField()
AtlasField	read(String docId, String path)
AtlasField	readConstant(String name)
AtlasField	readProperty(String scope, String name)
AtlasField	setRawField(io.atlasmap.v2.Field f)
void	write(String docId, String path)
void	writeProperty(String scope, String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

AtlasField

public AtlasField(DefaultAtlasSession session)

Method Detail

read

public AtlasField read(String docId,
                       String path)
                throws io.atlasmap.api.AtlasException

Throws:

io.atlasmap.api.AtlasException

readConstant

public AtlasField readConstant(String name)
                        throws io.atlasmap.api.AtlasException

Throws:

io.atlasmap.api.AtlasException

readProperty

public AtlasField readProperty(String scope,
                               String name)
                        throws io.atlasmap.api.AtlasException

Throws:

io.atlasmap.api.AtlasException

write

public void write(String docId,
                  String path)
           throws io.atlasmap.api.AtlasException

Throws:

io.atlasmap.api.AtlasException

writeProperty

public void writeProperty(String scope,
                          String name)
                   throws io.atlasmap.api.AtlasException

Throws:

io.atlasmap.api.AtlasException

action

public AtlasField action(String actionName,
                         List<Object> parameters)

getRawField

public io.atlasmap.v2.Field getRawField()

setRawField

public AtlasField setRawField(io.atlasmap.v2.Field f)