org.opensrp.api.domain

Class BaseEntity

java.lang.Object

org.opensrp.api.domain.BaseDataObject

org.opensrp.api.domain.BaseEntity

Direct Known Subclasses:

Client, Provider, User

public class BaseEntity
extends BaseDataObject

The BaseEntity is the parent entity that contains basic information for all other business entities. The class generalizes the identifiers, addresses, and attributes for other entities. The class is the generic representation of all other business entities those have different business roles in system. For example: A user in system can also be data provider. The User would have basic data into BaseEntity and specific information in User. The BaseEntity would also be referred by Provider to represent and link roles. This helps in getting reports for any dimension for any entity into the system.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseEntity()
	BaseEntity(String baseEntityId)
	BaseEntity(String baseEntityId, Map<String,String> identifiers)
	BaseEntity(String baseEntityId, Map<String,String> identifiers, Map<String,Object> attributes)
	BaseEntity(String baseEntityId, Map<String,String> identifiers, Map<String,Object> attributes, List<Address> addresses)

Method Summary

Modifier and Type	Method and Description
void	addAddress(Address address)
void	addAttribute(String name, Object value)
void	addIdentifier(String identifierType, String identifier)
List<Address>	getAddresses()
Object	getAttribute(String name)
Map<String,Object>	getAttributes()
String	getBaseEntityId()
String	getIdentifier(String identifierType)
String	getIdentifierMatchingRegex(String regex) Returns field matching the regex.
Map<String,String>	getIdentifiers()
void	removeAttribute(String name)
void	removeIdentifier(String identifierType)
void	setAddresses(List<Address> addresses) WARNING: Overrides all existing addresses
void	setAttributes(Map<String,Object> attributes) WARNING: Overrides all existing attributes
void	setBaseEntityId(String baseEntityId)
void	setIdentifiers(Map<String,String> identifiers)
String	toString()
BaseEntity	withAddress(Address address)
BaseEntity	withAddresses(List<Address> addresses) WARNING: Overrides all existing addresses
BaseEntity	withAttribute(String name, Object value)
BaseEntity	withAttributes(Map<String,Object> attributes) WARNING: Overrides all existing attributes
BaseEntity	withBaseEntityId(String baseEntityId)
BaseEntity	withIdentifier(String identifierType, String identifier)
BaseEntity	withIdentifiers(Map<String,String> identifiers) WARNING: Overrides all existing identifiers

Methods inherited from class org.opensrp.api.domain.BaseDataObject

getCreator, getDateCreated, getDateEdited, getDateVoided, getEditor, getVoided, getVoider, getVoidReason, setCreator, setDateCreated, setDateEdited, setDateVoided, setEditor, setVoided, setVoider, setVoidReason, withCreator, withDateCreated, withDateEdited, withDateVoided, withEditor, withVoided, withVoider, withVoidReason

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseEntity

protected BaseEntity()

BaseEntity

public BaseEntity(String baseEntityId)

BaseEntity

public BaseEntity(String baseEntityId,
                  Map<String,String> identifiers)

BaseEntity

public BaseEntity(String baseEntityId,
                  Map<String,String> identifiers,
                  Map<String,Object> attributes)

BaseEntity

public BaseEntity(String baseEntityId,
                  Map<String,String> identifiers,
                  Map<String,Object> attributes,
                  List<Address> addresses)

Method Detail

getBaseEntityId

public String getBaseEntityId()

setBaseEntityId

public void setBaseEntityId(String baseEntityId)

getAddresses

public List<Address> getAddresses()

setAddresses

public void setAddresses(List<Address> addresses)

WARNING: Overrides all existing addresses

Parameters:

addresses -

addAddress

public void addAddress(Address address)

getAttributes

public Map<String,Object> getAttributes()

getAttribute

public Object getAttribute(String name)

setAttributes

public void setAttributes(Map<String,Object> attributes)

WARNING: Overrides all existing attributes

Parameters:

attributes -

addAttribute

public void addAttribute(String name,
                         Object value)

removeAttribute

public void removeAttribute(String name)

getIdentifiers

public Map<String,String> getIdentifiers()

getIdentifier

public String getIdentifier(String identifierType)

getIdentifierMatchingRegex

public String getIdentifierMatchingRegex(String regex)

Returns field matching the regex. Note that incase of multiple fields matching criteria function would return first match. The must be well formed to find out a single value

Parameters:

regex -

Returns:

setIdentifiers

public void setIdentifiers(Map<String,String> identifiers)

addIdentifier

public void addIdentifier(String identifierType,
                          String identifier)

removeIdentifier

public void removeIdentifier(String identifierType)

withBaseEntityId

public BaseEntity withBaseEntityId(String baseEntityId)

withIdentifiers

public BaseEntity withIdentifiers(Map<String,String> identifiers)

WARNING: Overrides all existing identifiers

Parameters:

identifiers -

Returns:

withIdentifier

public BaseEntity withIdentifier(String identifierType,
                                 String identifier)

withAddresses

public BaseEntity withAddresses(List<Address> addresses)

WARNING: Overrides all existing addresses

Parameters:

addresses -

Returns:

withAddress

public BaseEntity withAddress(Address address)

withAttributes

public BaseEntity withAttributes(Map<String,Object> attributes)

WARNING: Overrides all existing attributes

Parameters:

attributes -

Returns:

withAttribute

public BaseEntity withAttribute(String name,
                                Object value)

toString

public String toString()

Overrides:

toString in class BaseDataObject