com.pubmatic.sdk.common.models

Class POBDataProvider

java.lang.Object

com.pubmatic.sdk.common.models.POBDataProvider

public class POBDataProvider
extends java.lang.Object

Model Class to Store Additional Data about the related object(e.g. user,app)

Constructor Summary

Constructors

Constructor and Description
POBDataProvider(java.lang.String name) Constructor to create object of POBDataProvider which Store Additional Data about the related object
POBDataProvider(java.lang.String name, java.lang.String id) Constructor to create object of POBDataProvider which Store Additional Data about the related object

Method Summary

Modifier and Type	Method and Description
void	addSegment(POBSegment segment) Method to add segment data for a data provider
JSONObject	getExt() Method to get additional data extension set in data provider
java.lang.String	getId() Method to get id of data provider
java.lang.String	getName() Method to get name of data provider
POBSegment	getSegment(java.lang.String segId) Method to get segment with given id
java.util.Map<java.lang.String,POBSegment>	getSegments() Method to get segments available in a data provider
int	getSegTax() Method to get id of segment taxonomy used
void	removeAllSegments() Method to remove All segments from a data provider
POBSegment	removeSegment(java.lang.String segId) Method to remove segment data from a data provider
void	setExt(JSONObject ext) Method to set additional data extension for a data provider
void	setSegTax(int segTax) Method to set id of segment taxonomy used by Data Provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

POBDataProvider

public POBDataProvider(@NonNull
                       java.lang.String name)

Constructor to create object of POBDataProvider which Store Additional Data about the related object

Parameters:

name - name of Data Provider

POBDataProvider

public POBDataProvider(@NonNull
                       java.lang.String name,
                       @Nullable
                       java.lang.String id)

Constructor to create object of POBDataProvider which Store Additional Data about the related object

Parameters:

name - name of Data Provider

id - id of Data Provider

Method Detail

getId

@Nullable
public java.lang.String getId()

Method to get id of data provider

getName

@NonNull
public java.lang.String getName()

Method to get name of data provider

getSegTax

public int getSegTax()

Method to get id of segment taxonomy used

setSegTax

public void setSegTax(int segTax)

Method to set id of segment taxonomy used by Data Provider. Default value of segTax will be zero

Parameters:

segTax - positive integer value of id of segment taxonomy used

getExt

@Nullable
public JSONObject getExt()

Method to get additional data extension set in data provider

setExt

public void setExt(@NonNull
                   JSONObject ext)

Method to set additional data extension for a data provider

Parameters:

ext - JSONObject

addSegment

public void addSegment(@NonNull
                       POBSegment segment)

Method to add segment data for a data provider

Parameters:

segment - instance of POBSegment class

removeSegment

@Nullable
public POBSegment removeSegment(@NonNull
                                          java.lang.String segId)

Method to remove segment data from a data provider

Parameters:

segId - id of the segment

removeAllSegments

public void removeAllSegments()

Method to remove All segments from a data provider

getSegment

@Nullable
public POBSegment getSegment(@NonNull
                                       java.lang.String segId)

Method to get segment with given id

Parameters:

segId - id of the segment

Returns:

instance of POBSegment with given id

getSegments

@NonNull
public java.util.Map<java.lang.String,POBSegment> getSegments()

Method to get segments available in a data provider

Returns:

Map of segments