com.atakmap.coremap.cot.event

Class CotEvent

java.lang.Object

com.atakmap.coremap.cot.event.CotEvent

All Implemented Interfaces:

android.os.Parcelable

public class CotEvent
extends java.lang.Object
implements android.os.Parcelable

Represents a Cursor on Target event http://cot.mitre.org

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<CotEvent>	CREATOR
static java.lang.String	HOW_HUMAN_GARBAGE_IN_GARBAGE_OUT Value of a human generated how attribute
static java.lang.String	HOW_MACHINE_GENERATED A good default and value of a machine generated how attribute
static java.lang.String	TAG
static java.lang.String	VERSION_2_0 Default version attribute value (2.0)

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
CotEvent() Create a default state event.
CotEvent(CotEvent event) Copy constructor.
CotEvent(android.os.Parcel source) Create the event from its Parcel representation.
CotEvent(java.lang.String _uid, java.lang.String _type, java.lang.String _vers, CotPoint _point, CoordinatedTime _time, CoordinatedTime _start, CoordinatedTime _stale, java.lang.String _how, CotDetail _detail, java.lang.String _opex, java.lang.String _qos, java.lang.String _access) Copy constructor.

Method Summary

Modifier and Type	Method and Description
void	buildXml(java.lang.Appendable b)
void	buildXml(java.lang.StringBuffer b) Given a string buffer, produce a well formed CoT message.
void	buildXml(java.lang.StringBuilder b) Given a string buffer, produce a well formed CoT message.
int	describeContents()
static java.lang.String	escapeXmlText(java.lang.String innerText)
CotDetail	findDetail(int startIndex, java.lang.String name) Find a detail element Convenience method for CotDetail.getFirstChildByName(int, String)
CotDetail	findDetail(java.lang.String name)
java.lang.String	getAccess()
CotPoint	getCotPoint() Get this event point as a CotPoint
CotDetail	getDetail() Get this event root detail
GeoPoint	getGeoPoint() From the CotPoint, derive the correct GeoPoint.
java.lang.String	getHow() Get this event how
static java.lang.String	getLogDateString() Retrieves a date as a formatted string useful for using as part of a file name.
java.lang.String	getOpex()
java.lang.String	getQos()
CoordinatedTime	getStale() Get this event stale time
CoordinatedTime	getStart() Get this event start time
CoordinatedTime	getTime() Get this event time
java.lang.String	getType() Get this event 'type' attribute
java.lang.String	getUID() Get this event UID
java.lang.String	getVersion() Get this 'version' attribute
boolean	isValid() Determine if the event is valid
static CotEvent	parse(java.lang.String xml) Parse a event from an XML string
void	setAccess(java.lang.String access) Set the 'access' attribute of the event
void	setDetail(CotDetail detail) Set the detail tag.
void	setHow(java.lang.String how) Set the 'how' attribute of the event (e.g.
static void	setLogInvalid(boolean log, java.io.File directory) Location to log invalid CoT messages.
void	setOpex(java.lang.String opex) Set the 'opex' attribute of the event
void	setPoint(CotPoint point) Set the point tag details
void	setQos(java.lang.String qos) Set the 'qos' (quality of service) attribute of the event
void	setStale(CoordinatedTime stale) Set the time this event leaves from scope
void	setStart(CoordinatedTime start) Set the time this event starts scope
void	setTime(CoordinatedTime time) Set the time this event was generated
void	setType(java.lang.String type) Set the CoT type (e.g.
void	setUID(java.lang.String uid) Set the unique identifier for the object the event describes
void	setVersion(java.lang.String vers) Set the version attribute.
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

VERSION_2_0

public static final java.lang.String VERSION_2_0

Default version attribute value (2.0)

See Also:

Constant Field Values

HOW_MACHINE_GENERATED

public static final java.lang.String HOW_MACHINE_GENERATED

A good default and value of a machine generated how attribute

See Also:

Constant Field Values

HOW_HUMAN_GARBAGE_IN_GARBAGE_OUT

public static final java.lang.String HOW_HUMAN_GARBAGE_IN_GARBAGE_OUT

Value of a human generated how attribute

See Also:

Constant Field Values

CREATOR

public static final android.os.Parcelable.Creator<CotEvent> CREATOR

Constructor Detail

CotEvent

public CotEvent()

Create a default state event. The default state is missing the required attributes 'uid', 'type', 'time', 'start', and 'stale'; The required attributes must be set before the event is valid (isValid()). The required inner point tag is defaulted to 0, 0 (CotPoint.ZERO_POINT) and no detail tag exists.

CotEvent

public CotEvent(java.lang.String _uid,
                java.lang.String _type,
                java.lang.String _vers,
                CotPoint _point,
                CoordinatedTime _time,
                CoordinatedTime _start,
                CoordinatedTime _stale,
                java.lang.String _how,
                CotDetail _detail,
                java.lang.String _opex,
                java.lang.String _qos,
                java.lang.String _access)

Copy constructor.

CotEvent

public CotEvent(CotEvent event)

Copy constructor. That is not crazy long

CotEvent

public CotEvent(android.os.Parcel source)

Create the event from its Parcel representation.

Parameters:

source - the source Parcel

Method Detail

isValid

public boolean isValid()

Determine if the event is valid

Returns:

the validity of the event.

getLogDateString

public static java.lang.String getLogDateString()

Retrieves a date as a formatted string useful for using as part of a file name.

Returns:

a logging date/time string based on the current system time in yyyyMMdd_HHmm_ss format.

setLogInvalid

public static void setLogInvalid(boolean log,
                                 java.io.File directory)

Location to log invalid CoT messages. For the purposes of ATAK this should be FileSystemUtils.getItem("cot");

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

getVersion

public java.lang.String getVersion()

Get this 'version' attribute

Returns:

a String indicating the version number

getType

public java.lang.String getType()

Get this event 'type' attribute

Returns:

the type attribute

getUID

public java.lang.String getUID()

Get this event UID

Returns:

the uid

getCotPoint

public CotPoint getCotPoint()

Get this event point as a CotPoint

Returns:

the cot point.

getGeoPoint

public GeoPoint getGeoPoint()

From the CotPoint, derive the correct GeoPoint. (convienence method)

Returns:

the GeoPoint derived from a CotPoint or null if the CotPoint is null.

getDetail

public CotDetail getDetail()

Get this event root detail

Returns:

findDetail

public CotDetail findDetail(int startIndex,
                            java.lang.String name)

Find a detail element Convenience method for CotDetail.getFirstChildByName(int, String)

Parameters:

startIndex - Child index to begin searching

name - Detail name

Returns:

CoT detail or null if not found

findDetail

public CotDetail findDetail(java.lang.String name)

getTime

public CoordinatedTime getTime()

Get this event time

Returns:

the time as a coordinated time.

getStart

public CoordinatedTime getStart()

Get this event start time

Returns:

the event start time as a coordinated time.

getStale

public CoordinatedTime getStale()

Get this event stale time

Returns:

the stale time as a coordinated time.

getHow

public java.lang.String getHow()

Get this event how

Returns:

the HOW

getOpex

public java.lang.String getOpex()

Returns:

the OPEX

getQos

public java.lang.String getQos()

Returns:

the QoS

getAccess

public java.lang.String getAccess()

Returns:

the Access flag

buildXml

public void buildXml(java.lang.StringBuffer b)

Given a string buffer, produce a well formed CoT message.

Parameters:

b - the string buffer.

buildXml

public void buildXml(java.lang.StringBuilder b)

Given a string buffer, produce a well formed CoT message.

Parameters:

b - the string builder.

buildXml

public void buildXml(java.lang.Appendable b)
              throws java.io.IOException

Throws:

java.io.IOException

parse

public static CotEvent parse(java.lang.String xml)

Parse a event from an XML string

Parameters:

xml -

Returns:

a CoT Event that can either be valid or invalid.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

escapeXmlText

public static java.lang.String escapeXmlText(java.lang.String innerText)

setVersion

public void setVersion(java.lang.String vers)

Set the version attribute. If not set, the value by default is "2.0".

Parameters:

vers - the version if it is other than 2.0

setType

public void setType(java.lang.String type)

Set the CoT type (e.g. a-f-G).

Parameters:

type - the type of the CoT event

setUID

public void setUID(java.lang.String uid)

Set the unique identifier for the object the event describes

Parameters:

uid - the unique identifier. Should be opaque and not used for interpretation.

setPoint

public void setPoint(CotPoint point)

Set the point tag details

Parameters:

point - the point

Throws:

java.lang.IllegalArgumentException - if point is null

setDetail

public void setDetail(CotDetail detail)

Set the detail tag. This must be named "detail" or be null.

Parameters:

detail - the detail tag

Throws:

java.lang.IllegalArgumentException - if the CotDetail element name isn't "detail"

setTime

public void setTime(CoordinatedTime time)

Set the time this event was generated

Parameters:

time - the time based on coordinated time.

setStart

public void setStart(CoordinatedTime start)

Set the time this event starts scope

Parameters:

start - the start time of the event.

setStale

public void setStale(CoordinatedTime stale)

Set the time this event leaves from scope

Parameters:

stale - the stale time of the event

setHow

public void setHow(java.lang.String how)

Set the 'how' attribute of the event (e.g. m-g)

Parameters:

how - the how for the event.

setOpex

public void setOpex(java.lang.String opex)

Set the 'opex' attribute of the event

Parameters:

opex -

setQos

public void setQos(java.lang.String qos)

Set the 'qos' (quality of service) attribute of the event

Parameters:

qos -

setAccess

public void setAccess(java.lang.String access)

Set the 'access' attribute of the event

Parameters:

access -