ContentDocument.java

/*
 * Copyright 2000-2013 Enonic AS
 * http://www.enonic.com/license
 */
package com.enonic.cms.core.search.query;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;

import com.enonic.cms.core.content.ContentKey;
import com.enonic.cms.core.content.ContentLocations;
import com.enonic.cms.core.content.access.ContentAccessEntity;
import com.enonic.cms.core.content.category.CategoryEntity;
import com.enonic.cms.core.content.category.CategoryKey;
import com.enonic.cms.core.content.contenttype.ContentTypeKey;
import com.enonic.cms.core.content.index.BigText;
import com.enonic.cms.core.content.index.ContentIndexConstants;
import com.enonic.cms.core.content.index.UserDefinedField;
import com.enonic.cms.core.structure.menuitem.MenuItemKey;

/**
 * This class implements the content resource.
 */
public final class ContentDocument
        implements ContentIndexConstants
{
    private final static HashSet<String> PROTECTED_FIELDS = new HashSet<String>( Arrays.asList( ALL_FIELDS ) );

    private final ContentKey contentKey;

    private CategoryKey categoryKey;

    private SimpleText categoryName;

    private ContentTypeKey contentTypeKey;

    private SimpleText contentTypeName;

    private ContentLocations contentLocations;

    private SimpleText title;

    private SimpleText name;

    private SimpleText ownerKey;

    private SimpleText ownerName;

    private SimpleText ownerQualifiedName;

    private SimpleText modifierKey;

    private SimpleText modifierName;

    private SimpleText modifierQualifiedName;

    private SimpleText assigneeKey;

    private SimpleText assigneeName;

    private SimpleText assigneeQualifiedName;

    private SimpleText assignerKey;

    private SimpleText assignerName;

    private SimpleText assignerQualifiedName;

    private Date assignmentDueDate;

    private Date created;

    private Date publishFrom;

    private Date publishTo;

    private Integer status;

    private Integer priority;

    private String languageCode;

    /**
     * The date time when the content as whole was last modifed.
     */
    private Date timestamp;

    /**
     * The date time when the content data was last modified.
     */
    private Date modified;

    private final Collection<UserDefinedField> userDefinedFields;

    private BigText binaryExtractedText;

    private final Collection<ContentAccessEntity> contentAccessRights;

    private CategoryEntity category;

    private final Map<MenuItemKey, Integer> orderedSections;

    public ContentDocument( ContentKey contentKey )
    {
        this.contentKey = contentKey;
        this.userDefinedFields = new ArrayList<UserDefinedField>();
        this.contentAccessRights = new ArrayList<ContentAccessEntity>();
        this.orderedSections = new HashMap<MenuItemKey, Integer>();
    }

    public ContentKey getContentKey()
    {
        return this.contentKey;
    }

    public CategoryKey getCategoryKey()
    {
        return this.categoryKey;
    }

    public void setCategoryKey( CategoryKey categoryKey )
    {
        this.categoryKey = categoryKey;
    }

    public SimpleText getCategoryName()
    {
        return categoryName;
    }

    public void setCategoryName( String name )
    {
        categoryName = new SimpleText( name );
    }

    public ContentTypeKey getContentTypeKey()
    {
        return this.contentTypeKey;
    }

    public void setContentTypeKey( ContentTypeKey contentTypeKey )
    {
        this.contentTypeKey = contentTypeKey;
    }

    public SimpleText getContentTypeName()
    {
        return contentTypeName;
    }

    public void setContentTypeName( String name )
    {
        contentTypeName = new SimpleText( name );
    }

    public ContentLocations getContentLocations()
    {
        return contentLocations;
    }

    public void setContentLocations( ContentLocations contentLocations )
    {
        this.contentLocations = contentLocations;
    }

    public void addUserDefinedField( UserDefinedField field )
    {
        if ( !isProtectedField( field.getName() ) )
        {
            this.userDefinedFields.add( field );
        }
    }

    public void addUserDefinedField( String name, String value )
    {
        addUserDefinedField( new UserDefinedField( name, new SimpleText( value ) ) );
    }

    public void addUserDefinedField( String name, SimpleText value )
    {
        addUserDefinedField( new UserDefinedField( name, value ) );
    }

    public Collection<UserDefinedField> getUserDefinedFields()
    {
        return this.userDefinedFields;
    }

    public BigText getBinaryExtractedText()
    {
        return this.binaryExtractedText;
    }

    public void setBinaryExtractedText( BigText value )
    {
        this.binaryExtractedText = value;
    }

    public SimpleText getTitle()
    {
        return title;
    }

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

    public SimpleText getName()
    {
        return name;
    }

    public void setName( final String name )
    {
        this.name = new SimpleText (name);
    }

    public SimpleText getOwnerKey()
    {
        return ownerKey;
    }

    public void setOwnerKey( String key )
    {
        ownerKey = new SimpleText( key );
        // If the key contains ASCII control characters, something is seriously wrong.
        assert ( ownerKey.toString().equals( key.toString().trim() ) );
    }

    public SimpleText getModifierKey()
    {
        return modifierKey;
    }

    public void setModifierKey( String key )
    {
        modifierKey = new SimpleText( key );
        // If the key contains ASCII control characters, something is seriously wrong.
        assert ( modifierKey.getText().equals( key.trim() ) );
    }

    public SimpleText getAssigneeKey()
    {
        return assigneeKey;
    }

    public void setAssigneeKey( String key )
    {
        assigneeKey = new SimpleText( key );
        // If the key contains ASCII control characters, something is seriously wrong.
        assert ( assigneeKey.getText().equals( key.trim() ) );
    }

    public SimpleText getAssigneeName()
    {
        return assigneeName;
    }

    public void setAssigneeName( String name )
    {
        assigneeName = new SimpleText( name );
    }

    public SimpleText getAssigneeQualifiedName()
    {
        return assigneeQualifiedName;
    }

    public void setAssigneeQualifiedName( String value )
    {
        this.assigneeQualifiedName = new SimpleText( value );
    }

    public SimpleText getAssignerKey()
    {
        return assignerKey;
    }

    public void setAssignerKey( String key )
    {
        assignerKey = new SimpleText( key );
        // If the key contains ASCII control characters, something is seriously wrong.
        assert ( assignerKey.getText().equals( key.trim() ) );
    }

    public SimpleText getAssignerName()
    {
        return assignerName;
    }

    public void setAssignerName( String name )
    {
        this.assignerName = new SimpleText( name );
    }

    public SimpleText getAssignerQualifiedName()
    {
        return assignerQualifiedName;
    }

    public void setAssignerQualifiedName( String value )
    {
        this.assignerQualifiedName = new SimpleText( value );
    }

    public Date getAssignmentDueDate()
    {
        return assignmentDueDate;
    }

    public void setAssignmentDueDate( Date assignmentDueDate )
    {
        this.assignmentDueDate = assignmentDueDate;
    }

    public Date getCreated()
    {
        return created;
    }

    public void setCreated( Date created )
    {
        this.created = created;
    }

    public Date getPublishFrom()
    {
        return publishFrom;
    }

    public void setPublishFrom( Date publishFrom )
    {
        this.publishFrom = publishFrom;
    }

    public Date getPublishTo()
    {
        return publishTo;
    }

    public void setPublishTo( Date publishTo )
    {
        this.publishTo = publishTo;
    }

    public Date getTimestamp()
    {
        return timestamp;
    }

    public void setTimestamp( Date timestamp )
    {
        this.timestamp = timestamp;
    }

    public Date getModified()
    {
        return modified;
    }

    public void setModified( Date modified )
    {
        this.modified = modified;
    }

    public Integer getStatus()
    {
        return status;
    }

    public void setStatus( Integer value )
    {
        this.status = value;
    }

    public Integer getPriority()
    {
        return priority;
    }

    public void setPriority( Integer value )
    {
        this.priority = value;
    }

    public String getLanguageCode()
    {
        return languageCode;
    }

    public void setLanguageCode( String languageCode )
    {
        this.languageCode = languageCode;
    }

    public SimpleText getOwnerName()
    {
        return ownerName;
    }

    public void setOwnerName( String name )
    {
        ownerName = new SimpleText( name );
    }

    public SimpleText getOwnerQualifiedName()
    {
        return ownerQualifiedName;
    }

    public void setOwnerQualifiedName( String value )
    {
        ownerQualifiedName = new SimpleText( value );
    }

    public SimpleText getModifierName()
    {
        return modifierName;
    }

    public void setModifierName( String name )
    {
        modifierName = new SimpleText( name );
    }

    public SimpleText getModifierQualifiedName()
    {
        return modifierQualifiedName;
    }

    public void setModifierQualifiedName( String value )
    {
        modifierQualifiedName = new SimpleText( value );
    }

    private boolean isProtectedField( String field )
    {
        return PROTECTED_FIELDS.contains( field );
    }

    public Collection<ContentAccessEntity> getContentAccessRights()
    {
        return contentAccessRights;
    }

    public void addContentAccessRights( Collection<ContentAccessEntity> contentAccessRights )
    {
        this.contentAccessRights.addAll( contentAccessRights );
    }

    public CategoryEntity getCategory()
    {
        return category;
    }

    public void setCategory( CategoryEntity category )
    {
        this.category = category;
    }

    public void addOrderedSection( MenuItemKey sectionKey, int orderPosition )
    {
        orderedSections.put( sectionKey, orderPosition );
    }

    public Map<MenuItemKey, Integer> getOrderedSections()
    {
        return orderedSections;
    }
}