gr.iti.mklab.framework.common.domain.Item Maven / Gradle / Ivy

Go to download
package gr.iti.mklab.framework.common.domain;

import java.util.ArrayList;
import java.util.Date;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import org.mongodb.morphia.annotations.Embedded;
import org.mongodb.morphia.annotations.Entity;
import org.mongodb.morphia.annotations.Index;
import org.mongodb.morphia.annotations.Indexes;
import org.mongodb.morphia.annotations.Transient;

/**
 * Represents a single social media post and acts as an envelop for the native object.
 *
 * @author 	Manos Schinas
 * 
 */

@Entity(value="Item", noClassnameStored=false)
@Indexes({
	@Index("id"), 
	@Index("-publicationTime"),
	@Index("uid, -publicationTime")
})
public class Item extends JSONable {

    /**
     *
     */
    private static final long serialVersionUID = -7934442049449016087L;


	public Item() {
    	
    }
    
    // The id of the original Item
    protected String reference;
    
    // The name of the stream that an Item comes from
    protected String source;
    
    // The title of an Item. It will be used just for searching and sentiment analysis. 
    protected String title;
    
    // The clean title of an Item
    protected String cleanTitle;
    
    // A short description of an Item
    protected String description;
    
    // A set of tags associated with an Item
    protected String[] tags;
    
    protected String text;

	// A set of labels that indicate the feeds that are associated with this item
    protected Set labels;
    
    // The SocialSensor internal id of the user => StreamName#userInternalId
    protected String uid;
    
    // A detailed instance of the user of an Item
    // This is not exposed in mongodb
    @Transient
    protected StreamUser streamUser;
    
    // A set of user ids for the mentioned users
    protected String[] mentions;
    
    // If an Item is a reply to another Item this field
    // keeps the id of the user of the first Item
    protected String inReply;
    
    // The user id of the original Item
    protected String referencedUserId;
    
    // The page of the original Item
    protected String pageUrl;
    
    // A list of URLs contained in the Item
    protected String[] links;
    
    // A set of WebPages contained in the Item
    // WebPage is a more detailed representation of URLs
    @Transient
    protected List webPages;
    
    // The publication time of an Item
    protected long publicationTime;
    
    // The last time this Item has been updated
    protected Date lastUpdated;
    
    // The time this Item has been inserted in the system
    protected long insertionTime;

    // The location associated with an Item.
    // Usually this field indicated the origin of the Item
    @Embedded
    protected Location location;
    
    // A list of media items contained in an Item
    // This is not exposed in mongodb 
    @Transient
    protected List mediaItems = new ArrayList();
    
    // A list of ids of the contained media items 
    protected List mediaIds = new ArrayList();
    
    // The sentiment of an Item
    protected String sentiment;
    
    // A list of representative keywords extracted from an Item
    protected List keywords = new ArrayList();
    
    // A list of named entities extracted from an Item
    @Embedded
    protected List entities;
    
    // The language of an Item
    protected String language;
    
    // An indicator whether an Item id original, a shared instance of a previous Item or a comment on a previous Item
    protected boolean original = true;
    
    // Popularity values 
    
    // Number of likes
    protected Long likes = 0L;
    
    // Number of the times an Item has been shared
    protected Long shares = 0L;
    
    // The number of comments associated with an Item
    protected Long comments = 0L;
    
    protected String minhash;
    
    protected String signature;
    
    protected List topics = new ArrayList();
    
    // Getters  & Setters for the fields of this class
    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getReference() {
        return reference;
    }

    public void setReference(String reference) {
        this.reference = reference;
    }

    public String getSource() {
        return source;
    }

    public void setSource(String source) {
        this.source = source;
        for(MediaItem mi : this.getMediaItems()) {
        	mi.setSource(source);
        }
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getCleanTitle() {
        return cleanTitle;
    }

    public void setCleanTitle(String cleanTitle) {
        this.cleanTitle = cleanTitle;
    }
    
    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String[] getTags() {
        return tags;
    }

    public void setTags(String[] tags) {
        this.tags = tags;
    }

    public String getText() {
		return text;
	}

	public void setText(String text) {
		this.text = text;
	}
	
    public String getUserId() {
        return uid;
    }

    public void setUserId(String uid) {
        this.uid = uid;
    }

    public Set getLabels() {
        return labels;
    }

    public void addLabels(List labels) {
    	this.labels = new HashSet();
    	if(labels != null) {
    		this.labels.addAll(labels);
        	for(MediaItem mi : this.getMediaItems()) {
        		mi.addLabels(labels);
        	}
    	}
    }

    public void addLabel(String label) {
    	labels = new HashSet();
    	if(label != null) {
    		labels.add(label);
    		for(MediaItem mi : this.getMediaItems()) {
            	mi.addLabel(label);
            }
    	}
    }
    
    public StreamUser getStreamUser() {
        return streamUser;
    }

    public void setStreamUser(StreamUser streamUser) {
        this.streamUser = streamUser;
    }

    public String[] getMentions() {
        return mentions;
    }

    public void setMentions(String[] mentions) {
        this.mentions = mentions;
    }

    public String getInReply() {
        return inReply;
    }

    public void setInReply(String inReply) {
        this.inReply = inReply;
    }

    public String getReferencedUserId() {
        return referencedUserId;
    }

    public void setReferencedUserId(String referencedUserId) {
        this.referencedUserId = referencedUserId;
    }

    public String[] getLinks() {
        return links;
    }

    public void setLinks(String[] links) {
        this.links = links;
    }

    public List getWebPages() {
        return webPages;
    }

    public void setWebPages(List webPages) {
        this.webPages = webPages;
    }

    public long getPublicationTime() {
        return publicationTime;
    }

    public void setPublicationTime(long publicationTime) {
        this.publicationTime = publicationTime;
    }

    public long getInsertionTime() {
        return insertionTime;
    }

    public void setInsertionTime(long insertionTime) {
        this.insertionTime = insertionTime;
    }

    public Location getLocation() {
        return location;
    }

    public void setLocation(Location location) {
        this.location = location;
    }

    public List getMediaItems() {
        return mediaItems;
    }

    public void setMediaItems(List mediaItems) {
        this.mediaItems = mediaItems;
    }

    public List getMediaIds() {
        return mediaIds;
    }

    public void setMediaIds(List mediaIds) {
        this.mediaIds = mediaIds;
    }

    public String getSentiment() {
        return sentiment;
    }

    public void setSentiment(String sentiment) {
        this.sentiment = sentiment;
    }

    public List getKeywords() {
        return keywords;
    }

    public void setKeywords(List keywords) {
        this.keywords = keywords;
    }

    public List getEntities() {
        return entities;
    }

    public void setEntities(List entities) {
        this.entities = entities;
    }

    public String getLanguage() {
        return language;
    }

    public void setLanguage(String language) {
        this.language = language;
    }

    public boolean isOriginal() {
        return original;
    }

    public void setOriginal(boolean original) {
        this.original = original;
    }

    public Long getLikes() {
        return likes;
    }

    public void setLikes(Long likes) {
        this.likes = likes;
    }

    public Long getShares() {
        return shares;
    }

    public void setShares(Long shares) {
        this.shares = shares;
    }

    public Long getComments() {
        return comments;
    }

    public void setComments(Long comments) {
        this.comments = comments;
    }
    
    public String getPageUrl() {
        return pageUrl;
    }

    public void setPageUrl(String pageUrl) {
        this.pageUrl = pageUrl;
    }

    public Double getLatitude() {
        if (location == null) {
            return null;
        }
        return location.getLatitude();
    }

    public Double getLongitude() {
        if (location == null) {
            return null;
        }
        return location.getLongitude();
    }

    public String getLocationName() {
        if (location == null) {
            return null;
        }
        return location.getName();
    }

    public String getCountryName() {
        if (location == null) {
            return null;
        }
        return location.getCountryName();
    }

	public String getMinhash() {
		return minhash;
	}

	public void setMinhash(String minhash) {
		this.minhash = minhash;
	}

	public void setLabels(Set labels) {
		this.labels = labels;
	}

	public String getSignature() {
		return signature;
	}

	public void setSignature(String signature) {
		this.signature = signature;
	}
	
    public List getTopics() {
		return topics;
	}

	public void setTopics(List topics) {
		this.topics = topics;
	}

	public void addTopic(String topic, Double score) {
		this.topics.add(new Topic(topic, score));
	}
	
}