Packageat.datacollection.workers
Classpublic class DataWorkerOverlay
InheritanceDataWorkerOverlay Inheritance DataWorkerGeneric



Public Properties
 PropertyDefined by
  allDataWorkerOptions : uint
Internal variable to store the Data Worker Options if all overlay data collection in enabled.
DataWorkerOverlay
  dataCollectionAllOverlays : Boolean
Provide Documentation
DataWorkerOverlay
  debugMode : Boolean = false
[static] Enables debug output.
DataWorkerOverlay
  duration : int
Internal variable to hold the value of the total duration of the video that was watched.
DataWorkerOverlay
  expectedItemType : String
[read-only]
DataWorkerOverlay
  filePath : String
Path to the source of the overlay.
DataWorkerOverlay
  isVideo : Boolean
Internal variable for video overlay data collection.
DataWorkerOverlay
  type : String
[read-only]
DataWorkerOverlay
  videoLength : int
Internal variable to hold the value of the length of a video overlay.
DataWorkerOverlay
Protected Properties
 PropertyDefined by
 Inherited_itemList : Array
An internal list of Data items for this worker class.
DataWorkerGeneric
Public Methods
 MethodDefined by
  
Constructor.
DataWorkerOverlay
  
DataWorkerOverlay
  
flush():void
DataWorkerOverlay
Protected Methods
 MethodDefined by
 Inherited
attachListeners(index:int):void
Attaches listeners that begin and end data events.
DataWorkerGeneric
  
checkIfOverlayIsAlreadyAdded(pUniqueID:String):Boolean
Determines if the overlay was already added to the internal list.
DataWorkerOverlay
  
findOverlayByUniqueID(pUniqueID:String):int
Finds the overlay by the unique id that was supplied when the overlay was created.
DataWorkerOverlay
 Inherited
Function goes through the hierarchy of the object passed and return the first instance of a presentation module in the chain.
DataWorkerGeneric
 Inherited
findTarget(pTarget:*):int
Finds a matching target in the _itemList and returns its position in the array.
DataWorkerGeneric
  
onEndEvent(e:Event = null):void
DataWorkerOverlay
  
onStartEvent(e:Event):void
DataWorkerOverlay
  
DataWorkerOverlay
 Inherited
parseOptions(index:int):void
This method iterates over the DataWorker Options that were specified in the in the Data Item Description and modifies the data before it is pushed into the database.
DataWorkerGeneric
 Inherited
pushToDatabase(index:int):void
This method pushes the BookStart, BookEnd and related slot data to the DataCollectionInterface to be inserted into the DataCollection database.
DataWorkerGeneric
 Inherited
removeListeners(index:int):void
Removes the listeners that were attached from the attachListeners(index:int) method.
DataWorkerGeneric
Public Constants
 ConstantDefined by
  DATA_EXPECTED_TYPE : String = "overlay"
[static]
DataWorkerOverlay
  DATA_TYPE : String = "dataCollectionOverlay"
[static]
DataWorkerOverlay
Property detail
allDataWorkerOptionsproperty
allDataWorkerOptions:uint  [read-write]

Internal variable to store the Data Worker Options if all overlay data collection in enabled.

Implementation
    public function get allDataWorkerOptions():uint
    public function set allDataWorkerOptions(value:uint):void
dataCollectionAllOverlaysproperty 
dataCollectionAllOverlays:Boolean  [read-write]

Provide Documentation

Implementation
    public function get dataCollectionAllOverlays():Boolean
    public function set dataCollectionAllOverlays(value:Boolean):void
debugModeproperty 
public static var debugMode:Boolean = false

Enables debug output.

durationproperty 
duration:int  [read-write]

Internal variable to hold the value of the total duration of the video that was watched.

Implementation
    public function get duration():int
    public function set duration(value:int):void
expectedItemTypeproperty 
expectedItemType:String  [read-only]Implementation
    public function get expectedItemType():String
filePathproperty 
filePath:String  [read-write]

Path to the source of the overlay. If the overlay is a video it is the path to the overlay video.

Implementation
    public function get filePath():String
    public function set filePath(value:String):void
isVideoproperty 
isVideo:Boolean  [read-write]

Internal variable for video overlay data collection.

Implementation
    public function get isVideo():Boolean
    public function set isVideo(value:Boolean):void
typeproperty 
type:String  [read-only]Implementation
    public function get type():String
videoLengthproperty 
videoLength:int  [read-write]

Internal variable to hold the value of the length of a video overlay.

Implementation
    public function get videoLength():int
    public function set videoLength(value:int):void
Constructor detail
DataWorkerOverlay()constructor
public function DataWorkerOverlay()

Constructor.

Method detail
addDataItem()method
public override function addDataItem(value:IDataItemDescription):voidParameters
value:IDataItemDescription
checkIfOverlayIsAlreadyAdded()method 
protected function checkIfOverlayIsAlreadyAdded(pUniqueID:String):Boolean

Determines if the overlay was already added to the internal list.

Parameters
pUniqueID:String

Returns
Boolean
findOverlayByUniqueID()method 
protected function findOverlayByUniqueID(pUniqueID:String):int

Finds the overlay by the unique id that was supplied when the overlay was created.

Parameters
pUniqueID:String

Returns
int — The position in the internal list of the current overlay.
flush()method 
public override function flush():void
onEndEvent()method 
protected override function onEndEvent(e:Event = null):voidParameters
e:Event (default = null)
onStartEvent()method 
protected override function onStartEvent(e:Event):voidParameters
e:Event
onStartEventALL()method 
protected function onStartEventALL():void
Constant detail
DATA_EXPECTED_TYPEconstant
public static const DATA_EXPECTED_TYPE:String = "overlay"
DATA_TYPEconstant 
public static const DATA_TYPE:String = "dataCollectionOverlay"