001package votorola.a.position; // Copyright 2009-2013, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.
002
003import java.io.*;
004import votorola.g.lang.*;
005
006
007/** An identifier of a position.
008  *
009  *     @see <a href='http://reluk.ca/w/Category:Position'
010  *                        target='_top'>Category:Position</a>
011  */
012public @ThreadSafe class PositionID implements Serializable // where serialized?  PositionalRevisions
013{
014
015
016    /** Constructs a PositionID.
017      */
018    public PositionID( String _personName, String _pollName )
019    {
020        personName = _personName;
021        pollName = _pollName;
022    }
023
024
025
026   // ------------------------------------------------------------------------------------
027
028
029    /** Returns the page name in the pollwiki of the specified position.
030      *
031      *     @param pollName this is ignored if the named person is actually a pipe.
032      *
033      *     @see votorola.a.Pollwiki#positionPageName(String,String)
034      */
035    public static String pageName( final String personName, final String pollName,
036      final PipeRecognizer pipeRecognizer )
037    {
038        final StringBuilder b = new StringBuilder();
039        b.append( "User:" ).append( personName );
040        if( !pipeRecognizer.isPipeName( personName )) b.append( '/' ).append( pollName );
041        return b.toString();
042    }
043
044
045
046    /** The username of the person.
047      */
048    public final String personName() { return personName; }
049
050
051        private final String personName;
052
053
054
055    /** The name of the poll.
056      */
057    public final String pollName() { return pollName; }
058
059
060        private final String pollName;
061
062
063}