Package ch.pschatzmann.edgar.base

Class Context

java.lang.Object

ch.pschatzmann.edgar.base.Context

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Context>

public class Context
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<Context>

Context for the calculation of the date and segment attribute

Author:

pschatzmann

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Context(XBRL xbrl, java.lang.String id)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Context o)
boolean	equals(java.lang.Object obj)
java.lang.String	getCompanyIdentifier()
java.lang.String	getDate()
java.util.Date	getDate(java.lang.String timeStr)
java.lang.String	getDateDescription()	Determines the label for the context id
java.lang.String	getDimensionDescription()
java.lang.String	getID()
java.lang.Integer	getMonths()	Determines the number of months for the indicated period
long	getMonths(java.util.Date start, java.util.Date end)
java.lang.Integer	getMonthsOld()
java.lang.String	getSegmentDescription()
java.util.List<Segment>	getSegments()
int	hashCode()
boolean	isValid()
boolean	isWithSegments()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Context

public Context(XBRL xbrl,
               java.lang.String id)

Method Detail

isValid

public boolean isValid()

getID

public java.lang.String getID()

getDate

public java.lang.String getDate()

getMonths

public java.lang.Integer getMonths()

Determines the number of months for the indicated period

Returns:

getMonths

public long getMonths(java.util.Date start,
                      java.util.Date end)

getDate

public java.util.Date getDate(java.lang.String timeStr)
                       throws java.text.ParseException

Throws:

java.text.ParseException

getMonthsOld

public java.lang.Integer getMonthsOld()

getDateDescription

public java.lang.String getDateDescription()

Determines the label for the context id

Returns:

isWithSegments

public boolean isWithSegments()

getSegments

public java.util.List<Segment> getSegments()

getCompanyIdentifier

public java.lang.String getCompanyIdentifier()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(Context o)

Specified by:

compareTo in interface java.lang.Comparable<Context>

getSegmentDescription

public java.lang.String getSegmentDescription()

getDimensionDescription

public java.lang.String getDimensionDescription()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object