database.java

实现了SyncML无线同步协议

/**
 * Copyright (C) 2003-2004 Funambol
 *
 *  This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 */


package sync4j.framework.database;

import java.security.Principal;

import org.apache.commons.lang.builder.ToStringBuilder;

import sync4j.framework.core.*;

/**
 * This class represents a synchronizable database.
 *
 * @author  Stefano Fornari @ Funambol
 * @version $Id: Database.java,v 1.6 2004/04/13 09:37:32 luigia Exp $
 */
public class Database {
    
    // -------------------------------------------------------------- Properties
    
    /**
     * The database name 
     */
    private String name = null;
    
    public String getName() {
        return this.name;
    }
    
    /**
     * The database type (e.g. text/x-vcard) 
     */
    private String type = null;
    
    public String getType() {
        return this.type;
    }
    
    public void setType(String type) {
        this.type = type;
    }
    
    /** 
     * The target of the database
     */
    private Target target = null;
    
    public Target getTarget() {
        return this.target;
    }
    
    public void setTarget(Target target) {
        this.target = target;
    }
    
    /** 
     * The source of the database
     */
    private Source source = null;
    
    public Source getSource() {
        return this.source;
    }
    
    public void setSource(Source source) {
        this.source = source;
    }
    
    /**
     * Client synchronization anchor
     */
    private Anchor anchor = null;
    
    public Anchor getAnchor() {
        return anchor;
    }
    
    public void setAnchor(Anchor anchor) {
        this.anchor = anchor;
    }
    
    /**
     * Server synchronization anchor
     */
    private Anchor serverAnchor = null;
    
    public Anchor getServerAnchor() {
        return serverAnchor;
    }
    
    public void setServerAnchor(Anchor serverAnchor) {
        this.serverAnchor = serverAnchor;
    }
    
    /**
     * Synchronization method
     */
    private int method = AlertCode.SLOW;
    
    public int getMethod() {
        return this.method;
    }
    
    public void setMethod(int method) {
        this.method = method;
    }
    
    /**
     * Database status
     */
    private int statusCode = StatusCode.OK;
    
    public int getStatusCode() {
        return statusCode;
    }
    
    public void setStatusCode(int statusCode) {
        this.statusCode = statusCode;
    }
    
    /**
     * The alert command used to request the sychronization of this database
     */
    private Alert alertCommand = null;
    
    public Alert getAlertCommand() {
        return this.alertCommand;
    }
    
    public void setAlertCommand(Alert alertCommand) {
        this.alertCommand = alertCommand;
    }
    
    /**
     * The associated principal
     */
    private Principal principal = null;
    
    /** Getter for property principal.
     * @return Value of property principal.
     *
     */
    public Principal getPrincipal() {
        return principal;
    }
    
    /** Setter for property principal.
     * @param principal New value of property principal.
     *
     */
    public void setPrincipal(Principal principal) {
        this.principal = principal;
    }
            
    // -------------------------------------------------------------------------
    
    /**
     * The items of the database to be added, copied, deleted, executed, replaced
     */
    private Item[] addItems       = null;
    private Item[] copyItems      = null;
    private Item[] deleteItems    = null;
    private Item[] execItems      = null;
    private Item[] replaceItems   = null;
    private Item[] existingItems  = null;
    
    public void setAddItems(Item[] items) {
        this.addItems = items;
    }
    
    public Item[] getAddItems() {
        return this.addItems;
    }
    
    public void setCopyItems(Item[] items) {
        this.copyItems = items;
    }
    
    public Item[] getCopyItems() {
        return this.copyItems;
    }
    
    public void setDeleteItems(Item[] items) {
        this.deleteItems = items;
    }
    
    public Item[] getDeleteItems() {
        return this.deleteItems;
    }
    
    public void setExecItems(Item[] items) {
        this.execItems = items;
    }
    
    public Item[] getExecItems() {
        return this.execItems;
    }
    
    public void setReplaceItems(Item[] items) {
        this.replaceItems = items;
    }
    
    public Item[] getReplaceItems() {
        return this.replaceItems;
    }
    
    public void setExistingItems(Item[] items) {
        this.existingItems = items;
    }
    
    public Item[] getExistingItems() {
        return this.existingItems;
    }
    
    // ------------------------------------------------------------ Constructors
    
    /** 
     * Creates a new instance of Database 
     *
     * @param name database idenfier - NOT NULL
     * @param name database type (e.g. text/x-vcard) - NULL
     * @param target database target - NULL
     * @param source database source - NULL
     * @param anchor database last/next anchor tags NULL
     * @param principal the associated Principal. NULL means no associated principal
     */
    public Database(String     name     ,
                    String     type     ,
                    Target     target   ,
                    Source     source   ,
                    Anchor     anchor   ,
                    Principal  principal) {
        if (name == null) {
            throw new NullPointerException("name cannot be null");
        }
        
        this.name      = name  ;
        this.type      = type  ;
        this.target    = target;
        this.source    = source;
        this.anchor    = anchor;
        this.principal = principal;
    }
    
    /**
     * Creates a new instance of Database 
     *
     * @param name database idenfier - NOT NULL
     */
    public Database(String name) {
        this(name, null, null, null, null, null);
    }
    
    // ---------------------------------------------------------- Public methods
    
    public String getLast() {
        return (anchor != null) ? anchor.getLast() : null;
    }
    
    public String getNext() {
        return (anchor != null) ? anchor.getNext() : null;
    }
    
    public String toString() {
        ToStringBuilder sb = new ToStringBuilder(this);
        
        sb.append("name",       name      ).
           append("type",       type      ).
           append("statusCode", statusCode).
           append("target",     target    ).
           append("source",     source    ).
           append("anchor",     anchor    ).
           append("principal",  principal );
        
        return sb.toString();
    }    
}