|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.hackystat.sensorbase.resource.projects.ProjectManager
public class ProjectManager
Provides a manager for the Project resource.
Field Summary | |
---|---|
(package private) DbManager |
dbManager
The DbManager associated with this server. |
static java.lang.String |
DEFAULT_PROJECT_NAME
The String naming the Default project. |
static java.lang.String |
projectIndexCloseTag
The ProjectIndex close tag. |
static java.lang.String |
projectIndexOpenTag
The ProjectIndex open tag. |
(package private) Server |
server
The Server associated with this SdtManager. |
(package private) UserManager |
userManager
The UserManager. |
Constructor Summary | |
---|---|
ProjectManager(Server server)
The constructor for ProjectManagers. |
Method Summary | |
---|---|
void |
addDefaultProject(User owner)
Creates and stores the "Default" project for the specified user. |
java.lang.String |
convertOwnerToEmail(java.lang.String owner)
Converts an "Owner" string to an email address. |
java.lang.String |
convertOwnerToUri(java.lang.String owner)
Returns the owner string as a URI. |
void |
deleteProject(User owner,
java.lang.String projectName)
Ensures that the passed Project is no longer present in this Manager. |
void |
deleteProjects(User owner)
Deletes all projects including the default project owned by this user. |
java.lang.String |
getMultiDayProjectSummaryString(Project project,
javax.xml.datatype.XMLGregorianCalendar startTime,
java.lang.Integer numDays)
Returns a MultiDayProjectSummary instance for the given project, startTime, and number of days. |
Project |
getProject(User owner,
java.lang.String projectName)
Returns the Project associated with user and projectName, or null if not found. |
java.lang.String |
getProjectIndex()
Returns the XML string containing the ProjectIndex with all defined Projects. |
java.lang.String |
getProjectIndex(User user)
Returns the XML string containing the ProjectIndex with all Projects associated with this user. |
java.util.Set<Project> |
getProjects()
Returns a set containing the current Project instances. |
java.util.Set<Project> |
getProjects(User user)
Returns all of the projects owned by this user. |
java.lang.String |
getProjectSensorDataIndex(User owner,
Project project)
Returns an XML SensorDataIndex String for all data associated with the Project owned by this user. |
java.lang.String |
getProjectSensorDataIndex(User owner,
Project project,
javax.xml.datatype.XMLGregorianCalendar startTime,
javax.xml.datatype.XMLGregorianCalendar endTime,
int startIndex,
int maxInstances)
Returns the XML SensorDataIndex string for the data associated with this Project within the specified start and end times and startIndex and maxInstances. |
java.lang.String |
getProjectSensorDataIndex(User owner,
Project project,
javax.xml.datatype.XMLGregorianCalendar startTime,
javax.xml.datatype.XMLGregorianCalendar endTime,
java.lang.String sdt)
Returns the XML SensorDataIndex string for the data associated with this Project within the specified start and end times. |
java.lang.String |
getProjectSensorDataIndex(User owner,
Project project,
javax.xml.datatype.XMLGregorianCalendar startTime,
javax.xml.datatype.XMLGregorianCalendar endTime,
java.lang.String sdt,
java.lang.String tool)
Returns the XML SensorDataIndex string for the data associated with this Project within the specified start and end times. |
java.lang.String |
getProjectSensorDataSnapshot(Project project,
javax.xml.datatype.XMLGregorianCalendar startTime,
javax.xml.datatype.XMLGregorianCalendar endTime,
java.lang.String sdt,
java.lang.String tool)
Returns a string containing a SensorDataIndex representing the "snapshot" of the sensor data for the given project in the given interval for the given sdt. |
java.lang.String |
getProjectString(User owner,
java.lang.String projectName)
Returns the Project Xml String associated with this User and project name. |
java.lang.String |
getProjectSummaryString(Project project,
javax.xml.datatype.XMLGregorianCalendar startTime,
javax.xml.datatype.XMLGregorianCalendar endTime)
Returns the XML ProjectSummary string for the data associated with this Project within the specified start and end times. |
boolean |
hasProject(User owner,
java.lang.String projectName)
Returns true if the passed Project name is defined for this User (who must be the owner). |
boolean |
hasProjects(User owner)
Returns true if the passed user has any defined Projects. |
boolean |
inProject(java.lang.String userEmail1,
java.lang.String userEmail2,
java.lang.String tstampString)
Returns true if user1 and user2 are members of the same Project and that project encompasses the given day. |
boolean |
isInvited(User owner,
java.lang.String projectName,
java.lang.String invitee)
Returns true if member is invited to be a member of the project owned by owner. |
boolean |
isMember(User owner,
java.lang.String projectName,
java.lang.String member)
Returns true if member is a member of the project owned by owner. |
boolean |
isSpectator(User owner,
java.lang.String projectName,
java.lang.String spectator)
Returns true if member is a spectator of the project owned by owner. |
java.lang.String |
makeMultiDayProjectSummaryString(MultiDayProjectSummary summary)
Returns the passed MultiDayProjectSummary as a String encoding of its XML representation. |
java.lang.String |
makeProject(Project project)
Returns the passed Project instance as a String encoding of its XML representation. |
Project |
makeProject(java.lang.String xmlString)
Takes a String encoding of a Project in XML format and converts it to an instance. |
ProjectIndex |
makeProjectIndex(java.lang.String xmlString)
Takes a String encoding of a ProjectIndex in XML format and converts it to an instance. |
ProjectRef |
makeProjectRef(Project project)
Returns a ProjectRef instance constructed from a Project instance. |
java.lang.String |
makeProjectRefString(Project project)
Returns the passed Project instance as a String encoding of its XML representation as a ProjectRef object. |
java.lang.String |
makeProjectSummaryString(ProjectSummary summary)
Returns the passed ProjectSummary instance as a String encoding of its XML representation. |
void |
putProject(Project project)
Updates the Manager with this Project. |
void |
renameProject(User owner,
java.lang.String projectName,
java.lang.String newProjectName)
Renames the project. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_PROJECT_NAME
Server server
DbManager dbManager
UserManager userManager
public static final java.lang.String projectIndexOpenTag
public static final java.lang.String projectIndexCloseTag
Constructor Detail |
---|
public ProjectManager(Server server)
server
- The Server instance associated with this ProjectManager.Method Detail |
---|
public java.lang.String convertOwnerToEmail(java.lang.String owner)
owner
- The owner string.
public java.lang.String convertOwnerToUri(java.lang.String owner)
owner
- The owner string.
public java.lang.String getProjectIndex()
public java.lang.String getProjectIndex(User user)
user
- The user whose associated Projects are to be retrieved. All projects for
which this user is an owner, member, spectator, or invitee are returned.
public void putProject(Project project)
project
- The Project.public void renameProject(User owner, java.lang.String projectName, java.lang.String newProjectName) throws java.lang.Exception
owner
- The owner of the project to be renamed.projectName
- The project to be renamed.newProjectName
- The new project name.
java.lang.Exception
- If projectName could not be found, or if newProjectName names an
existing project.public boolean hasProject(User owner, java.lang.String projectName)
owner
- The project owner (can be null).projectName
- A project name (can be null).
public boolean isMember(User owner, java.lang.String projectName, java.lang.String member)
owner
- The owner of projectName.projectName
- The name of the project owned by owner.member
- The user whose membership is being checked.
public boolean isInvited(User owner, java.lang.String projectName, java.lang.String invitee)
owner
- The owner of projectName.projectName
- The name of the project owned by owner.invitee
- The user whose invitation status is being checked.
public boolean isSpectator(User owner, java.lang.String projectName, java.lang.String spectator)
owner
- The owner of projectName.projectName
- The name of the project owned by owner.spectator
- The user whose spectator status is being checked.
public boolean inProject(java.lang.String userEmail1, java.lang.String userEmail2, java.lang.String tstampString)
userEmail1
- The first user.userEmail2
- The second user.tstampString
- The date in question, which could be null.
public void deleteProject(User owner, java.lang.String projectName)
owner
- The user who owns this Project.projectName
- The name of the project.public void deleteProjects(User owner)
owner
- The user of interest.public java.lang.String getProjectString(User owner, java.lang.String projectName)
owner
- The user that owns this project.projectName
- The name of the project.
public java.util.Set<Project> getProjects()
public java.util.Set<Project> getProjects(User user)
user
- The user whose projects are to be returned.
public java.lang.String getProjectSensorDataIndex(User owner, Project project) throws java.lang.Exception
owner
- The User that owns this Project.project
- the Project instance.
java.lang.Exception
- If things go wrong.public java.lang.String getProjectSensorDataIndex(User owner, Project project, javax.xml.datatype.XMLGregorianCalendar startTime, javax.xml.datatype.XMLGregorianCalendar endTime, java.lang.String sdt) throws java.lang.Exception
owner
- The User who owns this Project.project
- the Project.startTime
- The startTime.endTime
- The endTime.sdt
- The SensorDataType of interest, or null if all sensordatatypes are to be retrieved.
java.lang.Exception
- if problems occur.public java.lang.String getProjectSensorDataIndex(User owner, Project project, javax.xml.datatype.XMLGregorianCalendar startTime, javax.xml.datatype.XMLGregorianCalendar endTime, java.lang.String sdt, java.lang.String tool) throws java.lang.Exception
owner
- The User who owns this Project.project
- the Project.startTime
- The startTime.endTime
- The endTime.sdt
- The SensorDataType of interest, or null if all sensordatatypes are to be retrieved.tool
- The tool of interest.
java.lang.Exception
- if problems occur.public java.lang.String getProjectSensorDataIndex(User owner, Project project, javax.xml.datatype.XMLGregorianCalendar startTime, javax.xml.datatype.XMLGregorianCalendar endTime, int startIndex, int maxInstances) throws java.lang.Exception
owner
- The User who owns this Project.project
- the Project.startTime
- The startTime.endTime
- The endTime.startIndex
- The starting index within the timestamp-ordered list of all sensor data
instances associated with this project at the time of this call.maxInstances
- The maximum number of instances to return in the index.
java.lang.Exception
- if problems occur.public java.lang.String getProjectSensorDataSnapshot(Project project, javax.xml.datatype.XMLGregorianCalendar startTime, javax.xml.datatype.XMLGregorianCalendar endTime, java.lang.String sdt, java.lang.String tool) throws java.lang.Exception
project
- The project.startTime
- The start time.endTime
- The end time.sdt
- The sensor data type of interest.tool
- The tool of interest, or null if any tool is acceptable.
java.lang.Exception
- If problems occur.public java.lang.String getProjectSummaryString(Project project, javax.xml.datatype.XMLGregorianCalendar startTime, javax.xml.datatype.XMLGregorianCalendar endTime) throws java.lang.Exception
project
- the Project.startTime
- The startTimeXml.endTime
- The endTime.
java.lang.Exception
- if startString or endString are not XMLGregorianCalendars.public java.lang.String getMultiDayProjectSummaryString(Project project, javax.xml.datatype.XMLGregorianCalendar startTime, java.lang.Integer numDays) throws java.lang.Exception
project
- The Project.startTime
- The startTime.numDays
- The number of days.
java.lang.Exception
- If problems occur.public final void addDefaultProject(User owner)
owner
- The user who will own this Project.public boolean hasProjects(User owner)
owner
- The user who is the owner of the Projects.
public Project getProject(User owner, java.lang.String projectName)
owner
- The user.projectName
- A project name
public final Project makeProject(java.lang.String xmlString) throws java.lang.Exception
xmlString
- The XML string representing a Project
java.lang.Exception
- If problems occur during unmarshalling.public final ProjectIndex makeProjectIndex(java.lang.String xmlString) throws java.lang.Exception
xmlString
- The XML string representing a ProjectIndex.
java.lang.Exception
- If problems occur during unmarshalling.public final java.lang.String makeProject(Project project) throws java.lang.Exception
project
- The Project instance.
java.lang.Exception
- If problems occur during translation.public final java.lang.String makeProjectRefString(Project project) throws java.lang.Exception
project
- The Project instance.
java.lang.Exception
- If problems occur during translation.public final java.lang.String makeProjectSummaryString(ProjectSummary summary) throws java.lang.Exception
summary
- The ProjectSummary instance.
java.lang.Exception
- If problems occur during translation.public final java.lang.String makeMultiDayProjectSummaryString(MultiDayProjectSummary summary) throws java.lang.Exception
summary
- The MultiDayProjectSummary instance.
java.lang.Exception
- If problems occur during translation.public ProjectRef makeProjectRef(Project project)
project
- The Project instance.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |